Main documentation: simplify links and reflow text #1535
Merged
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 #1535 +/- ##
=======================================
Coverage 91.82% 91.82%
=======================================
Files 40 40
Lines 18345 18345
=======================================
Hits 16846 16846
Misses 1499 1499 ☔ View full report in Codecov by Sentry. |
djc
reviewed
Mar 22, 2024
| @@ -1,21 +1,23 @@ | |||
| //! # Chrono: Date and Time for Rust | |||
| //! | |||
|
|
|||
| //! Chrono aims to provide all functionality needed to do correct operations on dates and times in the | |||
| //! [proleptic Gregorian calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar): | |||
| //! Chrono aims to provide all functionality needed to do correct operations on dates and times in | |||
There was a problem hiding this comment.
How did you reflow? It doesn't look very consistent.
There was a problem hiding this comment.
Manually against a line at the 100-characters column in my editor. And sorry, it should be a bit better now. I missed a few lines, and later changes to a few links messed up parts that I did before.
djc
reviewed
Mar 22, 2024
djc
approved these changes
Mar 22, 2024
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.
It seems out main documentation needs a good rewrite, not everything matches what we would recommend today.
But for now I just simplified the links and reflowed the surrounding text.