add README to each crate#117
Merged
Merged
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 8 issues, and left some high level feedback:
- The README in
crates/try_v2_derivestill uses the# Try_v2heading and describes traits in addition to the derive macros; consider renaming the heading and tightening the description so it accurately reflects only the derive crate’s responsibilities. - The two READMEs are currently almost identical; you might want to factor the shared conceptual description into the main crate and keep the derive crate README minimal, or explicitly cross-link them to avoid duplication drifting over time.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The README in `crates/try_v2_derive` still uses the `# Try_v2` heading and describes traits in addition to the derive macros; consider renaming the heading and tightening the description so it accurately reflects only the derive crate’s responsibilities.
- The two READMEs are currently almost identical; you might want to factor the shared conceptual description into the main crate and keep the derive crate README minimal, or explicitly cross-link them to avoid duplication drifting over time.
## Individual Comments
### Comment 1
<location path="crates/try_v2/README.md" line_range="74" />
<code_context>
+
+## Stability & MSRV
+
+Given that this crate exposes an experimental API from std it makes use of experimental
+features which require a nightly toolchain.
+
</code_context>
<issue_to_address>
**suggestion (typo):** Add a comma after "std" to fix the run-on sentence.
The sentence reads as a run-on. Insert a comma after "std" ("from std, it makes use...") to improve readability.
```suggestion
Given that this crate exposes an experimental API from std, it makes use of experimental
```
</issue_to_address>
### Comment 2
<location path="crates/try_v2/README.md" line_range="91" />
<code_context>
+> 🔬 **Additional Experimental Features**
+>
+> - [`#![feature(if_let_guard)]`](https://github.com/rust-lang/rust/issues/51114) (stable since 1.95.0)
+> - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 on 2024 only)
+>
+> This list includes any unstable features used by direct & transitive dependencies (currently, none).
</code_context>
<issue_to_address>
**suggestion (typo):** Rephrase "on 2024 only" to use a more natural preposition.
The phrase “stable since 1.88.0 on 2024 only” reads awkwardly. Please reword to use a more natural preposition, e.g., “stable since 1.88.0 in 2024 only,” or another clearer phrasing.
```suggestion
> - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 in 2024 only)
```
</issue_to_address>
### Comment 3
<location path="crates/try_v2/README.md" line_range="101-102" />
<code_context>
+ We run automated tests **every month** to ensure no fundamental changes affect this crate and
+ test every PR against the current nightly, as well as the current equivalent beta & stable.
+ If you find an issue before we do, please
+ [raise an issue on github](https://github.com/MusicalNinjaDad/try_v2/issues).
+
+### MSRV
</code_context>
<issue_to_address>
**issue (typo):** Capitalize "GitHub" correctly in the link text.
Use the proper brand capitalization "GitHub" in the link text.
```suggestion
If you find an issue before we do, please
[raise an issue on GitHub](https://github.com/MusicalNinjaDad/try_v2/issues).
```
</issue_to_address>
### Comment 4
<location path="crates/try_v2/README.md" line_range="106-107" />
<code_context>
+### MSRV
+
+ For those of you working with a pinned nightly (etc.) this crate supports every version of
+ edition 2024 (rust 1.85.1 onwards, released as stable on 2025-03-18). We use
+ [autocfg](https://crates.io/crates/autocfg/) to seamlessly handle features which have been
+ stabilised since then.
</code_context>
<issue_to_address>
**suggestion (typo):** Capitalize "Rust" in "rust 1.85.1".
```suggestion
For those of you working with a pinned nightly (etc.) this crate supports every version of
edition 2024 (Rust 1.85.1 onwards, released as stable on 2025-03-18). We use
```
</issue_to_address>
### Comment 5
<location path="crates/try_v2_derive/README.md" line_range="74" />
<code_context>
+
+## Stability & MSRV
+
+Given that this crate exposes an experimental API from std it makes use of experimental
+features which require a nightly toolchain.
+
</code_context>
<issue_to_address>
**suggestion (typo):** Insert a comma after "std" for grammatical correctness.
This small punctuation change improves the sentence’s readability.
```suggestion
Given that this crate exposes an experimental API from std, it makes use of experimental
```
</issue_to_address>
### Comment 6
<location path="crates/try_v2_derive/README.md" line_range="91" />
<code_context>
+> 🔬 **Additional Experimental Features**
+>
+> - [`#![feature(if_let_guard)]`](https://github.com/rust-lang/rust/issues/51114) (stable since 1.95.0)
+> - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 on 2024 only)
+>
+> This list includes any unstable features used by direct & transitive dependencies (currently, none).
</code_context>
<issue_to_address>
**suggestion (typo):** Adjust the phrase "on 2024 only" to a more natural wording.
Please rephrase this to use a more natural preposition, for example "in 2024 only."
```suggestion
> - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 in 2024 only)
```
</issue_to_address>
### Comment 7
<location path="crates/try_v2_derive/README.md" line_range="101-102" />
<code_context>
+ We run automated tests **every month** to ensure no fundamental changes affect this crate and
+ test every PR against the current nightly, as well as the current equivalent beta & stable.
+ If you find an issue before we do, please
+ [raise an issue on github](https://github.com/MusicalNinjaDad/try_v2/issues).
+
+### MSRV
</code_context>
<issue_to_address>
**issue (typo):** Use the correct capitalization "GitHub" in the link text.
```suggestion
If you find an issue before we do, please
[raise an issue on GitHub](https://github.com/musicalninjadad/try_v2/issues).
```
</issue_to_address>
### Comment 8
<location path="crates/try_v2_derive/README.md" line_range="106-107" />
<code_context>
+### MSRV
+
+ For those of you working with a pinned nightly (etc.) this crate supports every version of
+ edition 2024 (rust 1.85.1 onwards, released as stable on 2025-03-18). We use
+ [autocfg](https://crates.io/crates/autocfg/) to seamlessly handle features which have been
+ stabilised since then.
</code_context>
<issue_to_address>
**suggestion (typo):** Capitalize "Rust" in the version reference.
Use "Rust 1.85.1" to match standard capitalization of the language name.
```suggestion
For those of you working with a pinned nightly (etc.) this crate supports every version of
edition 2024 (Rust 1.85.1 onwards, released as stable on 2025-03-18). We use
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
|
||
| ## Stability & MSRV | ||
|
|
||
| Given that this crate exposes an experimental API from std it makes use of experimental |
There was a problem hiding this comment.
suggestion (typo): Add a comma after "std" to fix the run-on sentence.
The sentence reads as a run-on. Insert a comma after "std" ("from std, it makes use...") to improve readability.
Suggested change
| Given that this crate exposes an experimental API from std it makes use of experimental | |
| Given that this crate exposes an experimental API from std, it makes use of experimental |
| > 🔬 **Additional Experimental Features** | ||
| > | ||
| > - [`#![feature(if_let_guard)]`](https://github.com/rust-lang/rust/issues/51114) (stable since 1.95.0) | ||
| > - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 on 2024 only) |
There was a problem hiding this comment.
suggestion (typo): Rephrase "on 2024 only" to use a more natural preposition.
The phrase “stable since 1.88.0 on 2024 only” reads awkwardly. Please reword to use a more natural preposition, e.g., “stable since 1.88.0 in 2024 only,” or another clearer phrasing.
Suggested change
| > - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 on 2024 only) | |
| > - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 in 2024 only) |
Comment on lines
+101
to
+102
| If you find an issue before we do, please | ||
| [raise an issue on github](https://github.com/MusicalNinjaDad/try_v2/issues). |
There was a problem hiding this comment.
issue (typo): Capitalize "GitHub" correctly in the link text.
Use the proper brand capitalization "GitHub" in the link text.
Suggested change
| If you find an issue before we do, please | |
| [raise an issue on github](https://github.com/MusicalNinjaDad/try_v2/issues). | |
| If you find an issue before we do, please | |
| [raise an issue on GitHub](https://github.com/MusicalNinjaDad/try_v2/issues). |
Comment on lines
+106
to
+107
| For those of you working with a pinned nightly (etc.) this crate supports every version of | ||
| edition 2024 (rust 1.85.1 onwards, released as stable on 2025-03-18). We use |
There was a problem hiding this comment.
suggestion (typo): Capitalize "Rust" in "rust 1.85.1".
Suggested change
| For those of you working with a pinned nightly (etc.) this crate supports every version of | |
| edition 2024 (rust 1.85.1 onwards, released as stable on 2025-03-18). We use | |
| For those of you working with a pinned nightly (etc.) this crate supports every version of | |
| edition 2024 (Rust 1.85.1 onwards, released as stable on 2025-03-18). We use |
|
|
||
| ## Stability & MSRV | ||
|
|
||
| Given that this crate exposes an experimental API from std it makes use of experimental |
There was a problem hiding this comment.
suggestion (typo): Insert a comma after "std" for grammatical correctness.
This small punctuation change improves the sentence’s readability.
Suggested change
| Given that this crate exposes an experimental API from std it makes use of experimental | |
| Given that this crate exposes an experimental API from std, it makes use of experimental |
| > 🔬 **Additional Experimental Features** | ||
| > | ||
| > - [`#![feature(if_let_guard)]`](https://github.com/rust-lang/rust/issues/51114) (stable since 1.95.0) | ||
| > - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 on 2024 only) |
There was a problem hiding this comment.
suggestion (typo): Adjust the phrase "on 2024 only" to a more natural wording.
Please rephrase this to use a more natural preposition, for example "in 2024 only."
Suggested change
| > - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 on 2024 only) | |
| > - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/53667) (stable since 1.88.0 in 2024 only) |
Comment on lines
+101
to
+102
| If you find an issue before we do, please | ||
| [raise an issue on github](https://github.com/MusicalNinjaDad/try_v2/issues). |
There was a problem hiding this comment.
issue (typo): Use the correct capitalization "GitHub" in the link text.
Suggested change
| If you find an issue before we do, please | |
| [raise an issue on github](https://github.com/MusicalNinjaDad/try_v2/issues). | |
| If you find an issue before we do, please | |
| [raise an issue on GitHub](https://github.com/musicalninjadad/try_v2/issues). |
Comment on lines
+106
to
+107
| For those of you working with a pinned nightly (etc.) this crate supports every version of | ||
| edition 2024 (rust 1.85.1 onwards, released as stable on 2025-03-18). We use |
There was a problem hiding this comment.
suggestion (typo): Capitalize "Rust" in the version reference.
Use "Rust 1.85.1" to match standard capitalization of the language name.
Suggested change
| For those of you working with a pinned nightly (etc.) this crate supports every version of | |
| edition 2024 (rust 1.85.1 onwards, released as stable on 2025-03-18). We use | |
| For those of you working with a pinned nightly (etc.) this crate supports every version of | |
| edition 2024 (Rust 1.85.1 onwards, released as stable on 2025-03-18). We use |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.