chore: use @[inherit_doc] more and remove some nolints#11905
Closed
chore: use @[inherit_doc] more and remove some nolints#11905
Conversation
This was referenced Apr 4, 2024
Closed
378de14 to
3bf0631
Compare
Member
These were actually never meant to go in the file, they are basically debugging information and only useful on significantly broken mathport files. You can safely remove all of them. |
Contributor
Author
Remove mathport names of these declarations.
mathlib-bors bot
pushed a commit
that referenced
this pull request
Apr 6, 2024
[Quoting](#11905 (comment)) `@digama0`: > These were actually never meant to go in the file, they are basically debugging information and only useful on significantly broken mathport files. You can safely remove all of them.
|
This PR/issue depends on:
|
j-loreaux
reviewed
Apr 7, 2024
Contributor
j-loreaux
left a comment
There was a problem hiding this comment.
Thanks! This is a chore that definitely needed doing. Admittedly, what I'm about to ask is a nontrivial amount of work, but it would be really nice if you could check all the docstrings for the things that are referenced and make sure they mention what the notation is. That way the user can be aware in both directions.
| Zsqrtd (-1) | ||
| #align gaussian_int GaussianInt | ||
|
|
||
| @[inherit_doc] |
Contributor
There was a problem hiding this comment.
Should we really be putting this on local notation?
Contributor
Author
There was a problem hiding this comment.
I've filed #11942 with more such changes :-) I'm doing this for ~two reasons:
- Why not, does it hurt?
1'. These changes remove some nolint entries, so something somewhere cares about this. - If I encounter some local notation in the middle of a file, that might not be obvious to me --- so showing some information hover seems useful.
As this is local notation, there is no sense in updating the referenced declaration's docstring. (If there is, I'd argue this notation should be scoped, but not local.) Hence, a bare inherit_doc feels appropriate.
I'm happy to move these changes to the other PR if you prefer.
|
|
||
| open scoped ComplexConjugate | ||
|
|
||
| @[inherit_doc] |
xgenereux
pushed a commit
that referenced
this pull request
Apr 15, 2024
[Quoting](#11905 (comment)) `@digama0`: > These were actually never meant to go in the file, they are basically debugging information and only useful on significantly broken mathport files. You can safely remove all of them.
atarnoam
pushed a commit
that referenced
this pull request
Apr 16, 2024
[Quoting](#11905 (comment)) `@digama0`: > These were actually never meant to go in the file, they are basically debugging information and only useful on significantly broken mathport files. You can safely remove all of them.
uniwuni
pushed a commit
that referenced
this pull request
Apr 19, 2024
[Quoting](#11905 (comment)) `@digama0`: > These were actually never meant to go in the file, they are basically debugging information and only useful on significantly broken mathport files. You can safely remove all of them.
callesonne
pushed a commit
that referenced
this pull request
Apr 22, 2024
[Quoting](#11905 (comment)) `@digama0`: > These were actually never meant to go in the file, they are basically debugging information and only useful on significantly broken mathport files. You can safely remove all of them.
Contributor
Author
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
3 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.
mathport name: <expression>lines #11928