Skip to content

[Merged by Bors] - chore(Data/Funlike): update examples and replace Lean 3 syntax#11409

Closed
grunweg wants to merge 4 commits intomasterfrom
MR-lean3-in-comments
Closed

[Merged by Bors] - chore(Data/Funlike): update examples and replace Lean 3 syntax#11409
grunweg wants to merge 4 commits intomasterfrom
MR-lean3-in-comments

Conversation

@grunweg
Copy link
Copy Markdown
Contributor

@grunweg grunweg commented Mar 15, 2024

Fully update the module docstrings (in particular, the examples given therein) after #8386.

This includes switching to where syntax, but also replacing Lean 3 syntax, replacing => by "\mapsto" while at it and indenting code per the style guide. As such, it's also a follow-up to #11301.

Co-authored-by: @Vierkantor


Open in Gitpod

- lambda by fun (and "=>" by "\mapsto", while I was it)
- remove commas after fields (there are seemingly allowed, but not necessary)
- indent code per the style guide

I did not consistently switch to `where` syntax; I was not sure if this has side effects (e.g. on performance). If desired, I can make that change also.

I did not test the code samples; they might be broken (but at least their syntax works).

Follow-up to #11301.
@dupuisf
Copy link
Copy Markdown
Contributor

dupuisf commented Mar 16, 2024

Here, there is an additional issue: the whole FunLike system was recently refactored, and it seems like these docstrings did not follow suit. @Vierkantor, could you have a look at this to make sure this documentation is updated correctly?

mathlib-bors bot pushed a commit that referenced this pull request Mar 17, 2024
Includes some doc comments and real code: this is exhaustive, with two exceptions:
- some files are handled in #11409 instead
- I left FunProp/{ToStd,RefinedDiscTree}.lean, Tactic/NormNum and Tactic/Simps alone, as these seem likely enough to end up in std.

Follow-up to #11301, much shorter this time.
@Vierkantor
Copy link
Copy Markdown
Contributor

Thank you for letting me know, I totally forgot about updating the EmbeddingLike docs. I think it's best if I push the fixes to this branch directly, since they are so extensive. Feel free to modify and revert if needed.

@ghost ghost added the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Mar 18, 2024
@grunweg grunweg changed the title chore(Data/Funlike): replace Lean 3 syntax in comments chore(Data/Funlike): update examples and replace Lean 3 syntax Mar 18, 2024
@ghost ghost removed the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Mar 18, 2024
@grunweg
Copy link
Copy Markdown
Contributor Author

grunweg commented Mar 18, 2024

Thank you for the thorough update! I have just merged master and updated the PR description.

Copy link
Copy Markdown
Contributor

@dupuisf dupuisf left a comment

Choose a reason for hiding this comment

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

Thanks!

bors r+

@ghost ghost added ready-to-merge This PR has been sent to bors. and removed awaiting-review labels Mar 20, 2024
mathlib-bors bot pushed a commit that referenced this pull request Mar 20, 2024
Fully update the module docstrings (in particular, the examples given therein) after #8386.

This includes switching to where syntax, but also replacing Lean 3 syntax, replacing => by "\mapsto" while at it and indenting code per the style guide. As such, it's also a follow-up to #11301.

Co-authored-by: @Vierkantor



Co-authored-by: Vierkantor <vierkantor@vierkantor.com>
@mathlib-bors
Copy link
Copy Markdown
Contributor

mathlib-bors bot commented Mar 20, 2024

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors bot changed the title chore(Data/Funlike): update examples and replace Lean 3 syntax [Merged by Bors] - chore(Data/Funlike): update examples and replace Lean 3 syntax Mar 20, 2024
@mathlib-bors mathlib-bors bot closed this Mar 20, 2024
@mathlib-bors mathlib-bors bot deleted the MR-lean3-in-comments branch March 20, 2024 12:03
dagurtomas pushed a commit that referenced this pull request Mar 22, 2024
Includes some doc comments and real code: this is exhaustive, with two exceptions:
- some files are handled in #11409 instead
- I left FunProp/{ToStd,RefinedDiscTree}.lean, Tactic/NormNum and Tactic/Simps alone, as these seem likely enough to end up in std.

Follow-up to #11301, much shorter this time.
dagurtomas pushed a commit that referenced this pull request Mar 22, 2024
Fully update the module docstrings (in particular, the examples given therein) after #8386.

This includes switching to where syntax, but also replacing Lean 3 syntax, replacing => by "\mapsto" while at it and indenting code per the style guide. As such, it's also a follow-up to #11301.

Co-authored-by: @Vierkantor



Co-authored-by: Vierkantor <vierkantor@vierkantor.com>
utensil pushed a commit that referenced this pull request Mar 26, 2024
Includes some doc comments and real code: this is exhaustive, with two exceptions:
- some files are handled in #11409 instead
- I left FunProp/{ToStd,RefinedDiscTree}.lean, Tactic/NormNum and Tactic/Simps alone, as these seem likely enough to end up in std.

Follow-up to #11301, much shorter this time.
utensil pushed a commit that referenced this pull request Mar 26, 2024
Fully update the module docstrings (in particular, the examples given therein) after #8386.

This includes switching to where syntax, but also replacing Lean 3 syntax, replacing => by "\mapsto" while at it and indenting code per the style guide. As such, it's also a follow-up to #11301.

Co-authored-by: @Vierkantor



Co-authored-by: Vierkantor <vierkantor@vierkantor.com>
xgenereux pushed a commit that referenced this pull request Apr 15, 2024
Includes some doc comments and real code: this is exhaustive, with two exceptions:
- some files are handled in #11409 instead
- I left FunProp/{ToStd,RefinedDiscTree}.lean, Tactic/NormNum and Tactic/Simps alone, as these seem likely enough to end up in std.

Follow-up to #11301, much shorter this time.
xgenereux pushed a commit that referenced this pull request Apr 15, 2024
Fully update the module docstrings (in particular, the examples given therein) after #8386.

This includes switching to where syntax, but also replacing Lean 3 syntax, replacing => by "\mapsto" while at it and indenting code per the style guide. As such, it's also a follow-up to #11301.

Co-authored-by: @Vierkantor



Co-authored-by: Vierkantor <vierkantor@vierkantor.com>
atarnoam pushed a commit that referenced this pull request Apr 16, 2024
Includes some doc comments and real code: this is exhaustive, with two exceptions:
- some files are handled in #11409 instead
- I left FunProp/{ToStd,RefinedDiscTree}.lean, Tactic/NormNum and Tactic/Simps alone, as these seem likely enough to end up in std.

Follow-up to #11301, much shorter this time.
atarnoam pushed a commit that referenced this pull request Apr 16, 2024
Fully update the module docstrings (in particular, the examples given therein) after #8386.

This includes switching to where syntax, but also replacing Lean 3 syntax, replacing => by "\mapsto" while at it and indenting code per the style guide. As such, it's also a follow-up to #11301.

Co-authored-by: @Vierkantor



Co-authored-by: Vierkantor <vierkantor@vierkantor.com>
uniwuni pushed a commit that referenced this pull request Apr 19, 2024
Includes some doc comments and real code: this is exhaustive, with two exceptions:
- some files are handled in #11409 instead
- I left FunProp/{ToStd,RefinedDiscTree}.lean, Tactic/NormNum and Tactic/Simps alone, as these seem likely enough to end up in std.

Follow-up to #11301, much shorter this time.
uniwuni pushed a commit that referenced this pull request Apr 19, 2024
Fully update the module docstrings (in particular, the examples given therein) after #8386.

This includes switching to where syntax, but also replacing Lean 3 syntax, replacing => by "\mapsto" while at it and indenting code per the style guide. As such, it's also a follow-up to #11301.

Co-authored-by: @Vierkantor



Co-authored-by: Vierkantor <vierkantor@vierkantor.com>
callesonne pushed a commit that referenced this pull request Apr 22, 2024
Includes some doc comments and real code: this is exhaustive, with two exceptions:
- some files are handled in #11409 instead
- I left FunProp/{ToStd,RefinedDiscTree}.lean, Tactic/NormNum and Tactic/Simps alone, as these seem likely enough to end up in std.

Follow-up to #11301, much shorter this time.
callesonne pushed a commit that referenced this pull request Apr 22, 2024
Fully update the module docstrings (in particular, the examples given therein) after #8386.

This includes switching to where syntax, but also replacing Lean 3 syntax, replacing => by "\mapsto" while at it and indenting code per the style guide. As such, it's also a follow-up to #11301.

Co-authored-by: @Vierkantor



Co-authored-by: Vierkantor <vierkantor@vierkantor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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