Skip to content

[Merged by Bors] - doc(Analysis/Convex/Slope) : fix a typo, add docstrings#13929

Closed
LorenzoLuccioli wants to merge 3 commits intomasterfrom
LL/slope_docstring
Closed

[Merged by Bors] - doc(Analysis/Convex/Slope) : fix a typo, add docstrings#13929
LorenzoLuccioli wants to merge 3 commits intomasterfrom
LL/slope_docstring

Conversation

@LorenzoLuccioli
Copy link
Copy Markdown
Collaborator

@LorenzoLuccioli LorenzoLuccioli commented Jun 18, 2024

  • Fix a typo in the docstrings ([x, z] instead of [y, z]). Happens multiple times in the file.
  • Add docstrings for ConvexOn.secant_mono, StrictConvexOn.secant_strict_mono and StrictConcaveOn.secant_strict_mono.
  • Remove a show tactic. It was added during the porting, but it seems that it is no longer needed. Happens twice.

Open in Gitpod

@LorenzoLuccioli LorenzoLuccioli added awaiting-review easy < 20s of review time. See the lifecycle page for guidelines. labels Jun 18, 2024
@github-actions
Copy link
Copy Markdown

PR summary 18f0eeebef

Import changes

No significant changes to the import graph


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/no_lost_declarations.sh short <optional_commit>

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

Copy link
Copy Markdown
Contributor

@grunweg grunweg left a comment

Choose a reason for hiding this comment

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

Thanks for the typo fixes and removed porting notes, these changes look good!
I think the docstrings have a "mathematical typo"; can you fix them, please?

linarith only [hf.secant_mono_aux1 hx hz hxy hyz]
#align convex_on.secant_mono_aux3 ConvexOn.secant_mono_aux3

/-- If `f : 𝕜 → 𝕜` is convex, then for any point `a` the slope of the secant line of `f` through `a`
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 is not fully accurate: f is convex on s, and a and x are points in s. Can you rephrase this doc-string accordingly, please?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Thank you for your comment.

Actually I had the same doubt, but I decided to write it like this in order to mimic the style of the other doc-strings in the same file. I thought that the fact that everything happens in s had been left implicit on purpose, so that the docs are easier to read.

What do you think is better: leave everything like it is, modify only the 3 new doc-strings or modify all the doc-strings in the file?

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.

Good point! I had not noticed this fact about the other doc-strings. I have asked on zulip now.

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.

I'm personally happy with this small lie.

maintainer merge

linarith only [hf.secant_strict_mono_aux1 hx hz hxy hyz]
#align strict_convex_on.secant_strict_mono_aux3 StrictConvexOn.secant_strict_mono_aux3

/-- If `f : 𝕜 → 𝕜` is strictly convex, then for any point `a` the slope of the secant line of `f`
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.

Similarly here, f is strictly convex on s, not globally.

· exact hf.secant_strict_mono_aux2 ha hy hxa hxy
#align strict_convex_on.secant_strict_mono StrictConvexOn.secant_strict_mono

/-- If `f : 𝕜 → 𝕜` is strictly concave, then for any point `a` the slope of the secant line of `f`
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.

Similarly here, f is strictly convace on s, not globally.

@grunweg grunweg added awaiting-author A reviewer has asked the author a question or requested changes. t-analysis Analysis (normed *, calculus) awaiting-review awaiting-zulip There is a Zulip discussion; the author should await and report/implement the decision reached there and removed awaiting-review easy < 20s of review time. See the lifecycle page for guidelines. awaiting-author A reviewer has asked the author a question or requested changes. labels Jun 18, 2024
@github-actions
Copy link
Copy Markdown

🚀 Pull request has been placed on the maintainer queue by YaelDillies.

@github-actions github-actions bot added the maintainer-merge A reviewer has approved the changed; awaiting maintainer approval. label Jun 18, 2024
Copy link
Copy Markdown
Member

@jcommelin jcommelin 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 merge

@ghost ghost added ready-to-merge This PR has been sent to bors. and removed awaiting-review labels Jun 19, 2024
@YaelDillies YaelDillies removed the awaiting-zulip There is a Zulip discussion; the author should await and report/implement the decision reached there label Jun 19, 2024
mathlib-bors bot pushed a commit that referenced this pull request Jun 19, 2024
- Fix a typo in the docstrings (`[x, z]` instead of `[y, z]`). Happens multiple times in the file.
- Add docstrings for `ConvexOn.secant_mono`, `StrictConvexOn.secant_strict_mono` and `StrictConcaveOn.secant_strict_mono`.
- Remove a `show` tactic. It was added during the porting, but it seems that it is no longer needed. Happens twice.
@mathlib-bors
Copy link
Copy Markdown
Contributor

mathlib-bors bot commented Jun 19, 2024

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors bot changed the title doc(Analysis/Convex/Slope) : fix a typo, add docstrings [Merged by Bors] - doc(Analysis/Convex/Slope) : fix a typo, add docstrings Jun 19, 2024
@mathlib-bors mathlib-bors bot closed this Jun 19, 2024
@mathlib-bors mathlib-bors bot deleted the LL/slope_docstring branch June 19, 2024 10:33
AntoineChambert-Loir pushed a commit that referenced this pull request Jun 20, 2024
- Fix a typo in the docstrings (`[x, z]` instead of `[y, z]`). Happens multiple times in the file.
- Add docstrings for `ConvexOn.secant_mono`, `StrictConvexOn.secant_strict_mono` and `StrictConcaveOn.secant_strict_mono`.
- Remove a `show` tactic. It was added during the porting, but it seems that it is no longer needed. Happens twice.
grunweg pushed a commit that referenced this pull request Jun 20, 2024
- Fix a typo in the docstrings (`[x, z]` instead of `[y, z]`). Happens multiple times in the file.
- Add docstrings for `ConvexOn.secant_mono`, `StrictConvexOn.secant_strict_mono` and `StrictConcaveOn.secant_strict_mono`.
- Remove a `show` tactic. It was added during the porting, but it seems that it is no longer needed. Happens twice.
kbuzzard pushed a commit that referenced this pull request Jun 26, 2024
- Fix a typo in the docstrings (`[x, z]` instead of `[y, z]`). Happens multiple times in the file.
- Add docstrings for `ConvexOn.secant_mono`, `StrictConvexOn.secant_strict_mono` and `StrictConcaveOn.secant_strict_mono`.
- Remove a `show` tactic. It was added during the porting, but it seems that it is no longer needed. Happens twice.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintainer-merge A reviewer has approved the changed; awaiting maintainer approval. ready-to-merge This PR has been sent to bors. t-analysis Analysis (normed *, calculus)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants