Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Merged by Bors] - doc(NumberTheory/Ostrowski): tweak documentation #18028

Closed
wants to merge 5 commits into from

Conversation

fbarroero
Copy link
Collaborator

@fbarroero fbarroero commented Oct 21, 2024

This PR modifies the documentation of the file in the hope of improving it.


Open in Gitpod

Fix doc

---
<!-- The text above the `---` will become the commit message when your
PR is merged. Please leave a blank newline before the `---`, otherwise
GitHub will format the text above it as a title.

For details on the "pull request lifecycle" in mathlib, please see:
https://leanprover-community.github.io/contribute/index.html

In particular, note that most reviewers will only notice your PR
if it passes the continuous integration checks.
Please ask for help on https://leanprover.zulipchat.com if needed.

To indicate co-authors, include lines at the bottom of the commit message
(that is, before the `---`) using the following format:

Co-authored-by: Author Name <author@email.com>

If you are moving or deleting declarations, please include these lines at the bottom of the commit message
(that is, before the `---`) using the following format:

Moves:
- Vector.* -> Mathlib.Vector.*
- ...

Deletions:
- Nat.bit1_add_bit1
- ...

Any other comments you want to keep out of the PR commit should go
below the `---`, and placed outside this HTML comment, or else they
will be invisible to reviewers.

If this PR depends on other PRs, please list them below this comment,
using the following format:
- [ ] depends on: #abc [optional extra text]
- [ ] depends on: #xyz [optional extra text]

-->

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
Copy link

github-actions bot commented Oct 21, 2024

PR summary c88dedb3ae

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.

@github-actions github-actions bot added the t-number-theory Number theory (also use t-algebra or t-analysis to specialize) label Oct 21, 2024
@fbarroero fbarroero changed the title doc doc(NumberTheory/Ostrowski) Fix documentation Oct 21, 2024
@fbarroero fbarroero added the documentation Improvements or additions to documentation label Oct 21, 2024
@grunweg grunweg changed the title doc(NumberTheory/Ostrowski) Fix documentation doc(NumberTheory/Ostrowski): fix documentation Oct 21, 2024
@grunweg grunweg changed the title doc(NumberTheory/Ostrowski): fix documentation doc(NumberTheory/Ostrowski): tweak documentation Oct 21, 2024
Copy link
Member

@riccardobrasca riccardobrasca 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 d+

@@ -236,15 +236,15 @@ lemma mulRingNorm_eq_one_of_not_dvd {m : ℕ} (hpm : ¬ p ∣ m) : f m = 1 := by
-- ## Step 4: f p = p ^ (- t) for some positive real t

include hp0 hp1 hmin in
/-- The absolute value of `p` is `p ^ (-t)` for some positive real number `t`. -/
/-- The absolute value of `p` is `p⁻ᵗ` for some positive real number `t`. -/
Copy link
Member

Choose a reason for hiding this comment

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

I think we usually follow Lean notation in docstring (also below).

@mathlib-bors
Copy link
Contributor

mathlib-bors bot commented Oct 22, 2024

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

@riccardobrasca
Copy link
Member

bors merge

@github-actions github-actions bot added the ready-to-merge This PR has been sent to bors. label Oct 22, 2024
mathlib-bors bot pushed a commit that referenced this pull request Oct 22, 2024
This PR modifies the documentation of the file in the hope of improving it.
@mathlib-bors
Copy link
Contributor

mathlib-bors bot commented Oct 22, 2024

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors bot changed the title doc(NumberTheory/Ostrowski): tweak documentation [Merged by Bors] - doc(NumberTheory/Ostrowski): tweak documentation Oct 22, 2024
@mathlib-bors mathlib-bors bot closed this Oct 22, 2024
@mathlib-bors mathlib-bors bot deleted the fbarroero_ostr_fix branch October 22, 2024 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
delegated documentation Improvements or additions to documentation ready-to-merge This PR has been sent to bors. t-number-theory Number theory (also use t-algebra or t-analysis to specialize)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants