[Merged by Bors] - chore: homogenize TODO format#14474
Closed
Conversation
PR summary 018ad86087Import changes for modified filesNo significant changes to the import graph Import changes for all files
Declarations diffNo declarations were harmed in the making of this PR! 🐙 You can run this locally as follows## summary with just the declaration names:
./scripts/no_lost_declarations.sh short <optional_commit>
## more verbose report:
./scripts/no_lost_declarations.sh <optional_commit> |
Collaborator
Author
|
There is also 50 occurrences of "Future Work", which I suppose could also be replaced with "TODO", but that seems more controversial, so I leave it for now... |
rwst
approved these changes
Jul 6, 2024
Collaborator
rwst
left a comment
There was a problem hiding this comment.
Exactly what is described, except the very last change, which leaves three ###s. LGTM
Collaborator
Author
For this one, the three ###s make sense, because there are multiple TODOs in different levels. |
Member
|
bors merge Thanks! |
mathlib-bors bot
pushed a commit
that referenced
this pull request
Jul 9, 2024
This makes sure that the by far most common way of declaring TODOs in module doc comments is also used by the few that deviated from that. This makes sure that it is easier to find those. Drive by: fix number of `#` for some other headings, to make doc strings more uniform. Co-authored-by: Moritz Firsching <firsching@google.com>
Contributor
|
Pull request successfully merged into master. Build succeeded: |
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
4 participants
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.
This makes sure that the by far most common way of declaring TODOs in module doc comments is also used by the few that deviated from that. This makes sure that it is easier to find those.
Drive by: fix number of
#for some other headings, to make doc strings more uniform.