Increased documentation content of README and root rustdoc page. #296
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
michaelkirk
reviewed
Sep 1, 2022
|
This is really a great improvement! I agree with the incremental approach for better docs. So we should merge this PR and then add more docs later. |
lnicola
reviewed
Sep 2, 2022
lnicola
reviewed
Sep 2, 2022
lnicola
reviewed
Sep 2, 2022
lnicola
reviewed
Sep 2, 2022
lnicola
reviewed
Sep 2, 2022
lnicola
reviewed
Sep 2, 2022
lnicola
approved these changes
Sep 2, 2022
|
Pro tip: when writing Markdown (or TeX, or text), it's better to keep it at one sentence/phrase per line. This makes it easier to view diffs. |
lnicola
reviewed
Sep 2, 2022
lnicola
reviewed
Sep 2, 2022
lnicola
reviewed
Sep 2, 2022
Clarification on C vs C++ documentation. Update README.md Update CHANGES.md
metasim
force-pushed
the
feature/more-readme
branch
from
3580ea8
to
7f382ea
Compare
|
bors r+ |
|
Build succeeded: |
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.
CHANGES.mdif knowledge of this change could be valuable to users.I wanted to kickstart some work to level-up the documentation. Wanting to take an incremental approach, making it feel a bit less intimidating to make progress in the future. I don't see this as the only PR I do on this, just a start. All feedback welcome :).
Related: