Mention the fact that the book uses some APIs from the git version #408
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #408 +/- ##
=======================================
Coverage 53.23% 53.23%
=======================================
Files 143 143
Lines 12665 12665
=======================================
Hits 6742 6742
Misses 5923 5923 ☔ View full report in Codecov by Sentry. |
|
I would then remove my note and just leave yours, thoughts? |
|
Oops, lol |
|
Sure. I also added a more generic disclaimer to not fully trust the book, rather than just warn about "nightly" APIs being used. |
marc2332
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I was going through the book and noticed that some APIs in it (e.g.,
position) are not in the crates.io version (currently0.1.8). This PR just adds a warning at the beginning of the book. I know there's a note saying that the book is not always accurate, but it's not very helpful and explicit in this particular case.