Skip to content

[Merged by Bors] - chore: ensure inherit_doc-ed notation is mentioned in the underlying doc-string#20684

Closed
grunweg wants to merge 25 commits intomasterfrom
MR-inheritdoc-2
Closed

[Merged by Bors] - chore: ensure inherit_doc-ed notation is mentioned in the underlying doc-string#20684
grunweg wants to merge 25 commits intomasterfrom
MR-inheritdoc-2

Conversation

@grunweg
Copy link
Copy Markdown
Contributor

@grunweg grunweg commented Jan 12, 2025

This is not exhaustive. Add some inherit_doc when appropriate.


Commits can be reviewed separately.

Open in Gitpod

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 12, 2025

PR summary b76c60e824

Import changes for modified files

No significant changes to the import graph

Import changes for all files
Files Import difference

Declarations diff

No declarations were harmed in the making of this PR! 🐙

You can run this locally as follows
## summary with just the declaration names:
./scripts/declarations_diff.sh <optional_commit>

## more verbose report:
./scripts/declarations_diff.sh long <optional_commit>

The doc-module for script/declarations_diff.sh contains some details about this script.


Decrease in tech debt: (relative, absolute) = (17.00, 0.03)
Current number Change Type
648 -17 documentation nolint entries

Current commit b76c60e824
Reference commit 8f355f5e88

You can run this locally as

./scripts/technical-debt-metrics.sh pr_summary
  • The relative value is the weighted sum of the differences with weight given by the inverse of the current value of the statistic.
  • The absolute value is the relative value divided by the total sum of the inverses of the current values (i.e. the weighted average of the differences).

@grunweg
Copy link
Copy Markdown
Contributor Author

grunweg commented Jan 12, 2025

@j-loreaux This performs some of the menial task you asked me to on #11905. Would you like to review (part of) this PR?

@j-loreaux j-loreaux self-requested a review January 12, 2025 20:52
/-- Composing two partial equivs, by restricting to the maximal domain where their composition
is well defined. -/
is well defined.
Within the `Manifold` namespace, there is the notation `e ≫ f` for this.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one seems strange on its face. Can you double check?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This notation is defined in Geometry/Manifold/ChartedSpace.lean. I'm not sure if this is the best solution; I could also simply add a comment there.

/-- Composing two partial homeomorphisms, by restricting to the maximal domain where their
composition is well defined. -/
composition is well defined.
Within the `Manifold` namespace, there is the notation `e ≫ₕ f` for this. -/
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For my laziness, can you point me to where this is

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly: in Geometry/Manifold/ChartedSpace.lean

grunweg and others added 3 commits January 13, 2025 21:52
Co-authored-by: Matthew Robert Ballard <100034030+mattrobball@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@mattrobball mattrobball left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks to good to me.

Two larger points for the future:

  • a @[scoped NS] attribute might be appealing cosmetically
  • rarely do I read a math paper that says "Notation is...". It is almost always "denoted as ..."

@mattrobball
Copy link
Copy Markdown
Contributor

bors delegate+

@mathlib-bors
Copy link
Copy Markdown
Contributor

mathlib-bors bot commented Jan 14, 2025

✌️ grunweg can now approve this pull request. To approve and merge a pull request, simply reply with bors r+. More detailed instructions are available here.

@ghost ghost added the delegated This pull request has been delegated to the PR author (or occasionally another non-maintainer). label Jan 14, 2025
@leanprover-community-bot-assistant leanprover-community-bot-assistant added the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Jan 21, 2025
@github-actions github-actions bot removed the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Jan 25, 2025
@grunweg
Copy link
Copy Markdown
Contributor Author

grunweg commented Jan 25, 2025

Thanks for the review! I have audited all occurrences (on a long train ride); this should be good to go now.

@grunweg grunweg added the auto-merge-after-CI Please do not add manually. Requests for a bot to merge automatically once CI is done. label Jan 25, 2025
@ghost
Copy link
Copy Markdown

ghost commented Jan 25, 2025

As this PR is labelled auto-merge-after-CI, we are now sending it to bors:

bors merge

@ghost ghost added the ready-to-merge This PR has been sent to bors. label Jan 25, 2025
mathlib-bors bot pushed a commit that referenced this pull request Jan 25, 2025
…g doc-string (#20684)

This is not exhaustive. Add some `inherit_doc` when appropriate.



Co-authored-by: grunweg <rothgami@math.hu-berlin.de>
@mathlib-bors
Copy link
Copy Markdown
Contributor

mathlib-bors bot commented Jan 25, 2025

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors bot changed the title chore: ensure inherit_doc-ed notation is mentioned in the underlying doc-string [Merged by Bors] - chore: ensure inherit_doc-ed notation is mentioned in the underlying doc-string Jan 25, 2025
@mathlib-bors mathlib-bors bot closed this Jan 25, 2025
@mathlib-bors mathlib-bors bot deleted the MR-inheritdoc-2 branch January 25, 2025 01:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-merge-after-CI Please do not add manually. Requests for a bot to merge automatically once CI is done. delegated This pull request has been delegated to the PR author (or occasionally another non-maintainer). ready-to-merge This PR has been sent to bors.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants