Skip to content

[Merged by Bors] - doc: Improve documentation of ordinal-indexed approximations#16406

Closed
PhoenixIra wants to merge 9 commits intomasterfrom
ira/OrdinalApprox_doc
Closed

[Merged by Bors] - doc: Improve documentation of ordinal-indexed approximations#16406
PhoenixIra wants to merge 9 commits intomasterfrom
ira/OrdinalApprox_doc

Conversation

@PhoenixIra
Copy link
Copy Markdown
Collaborator

As mentioned in #15522, the documentation uses heavily the wording "ordinal approximation", which suggests that ordinals are approximated. This PR changes it to "ordinal-indexed approximation" and highlights the indexed nature of ordinals in various places. It also fixes some apparent then vs than errors.

I appreciate any suggestions to further improve the documentation and hints for spelling mistakes.

Open in Gitpod

@PhoenixIra PhoenixIra added the t-logic Logic (model theory, etc) label Sep 2, 2024
@github-actions github-actions bot added the new-contributor This PR was made by a contributor with at most 5 merged PRs. Welcome to the community! label Sep 2, 2024
@github-actions
Copy link
Copy Markdown

github-actions bot commented Sep 2, 2024

PR summary 6b82842bdc

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.

Copy link
Copy Markdown
Collaborator

@vihdzp vihdzp left a comment

Choose a reason for hiding this comment

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

These new docstrings are definitely clearer. I've left a few spell-checking remarks as well as more opinionated suggestions (which all apply dually to gfpApprox).

@YaelDillies YaelDillies added the awaiting-author A reviewer has asked the author a question or requested changes. label Sep 24, 2024
vihdzp and others added 2 commits September 24, 2024 09:57
Co-authored-by: Yaël Dillies <yael.dillies@gmail.com>
Co-authored-by: Yaël Dillies <yael.dillies@gmail.com>
@vihdzp
Copy link
Copy Markdown
Collaborator

vihdzp commented Sep 24, 2024

Oh, I'm sorry! I thought this was my PR for a sec...

@PhoenixIra
Copy link
Copy Markdown
Collaborator Author

I appreciate the help anyway!

@PhoenixIra PhoenixIra removed the awaiting-author A reviewer has asked the author a question or requested changes. label Sep 25, 2024
@YaelDillies YaelDillies added the awaiting-author A reviewer has asked the author a question or requested changes. label Sep 25, 2024
@YaelDillies
Copy link
Copy Markdown
Contributor

maintainer merge

@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 Sep 25, 2024
@fpvandoorn
Copy link
Copy Markdown
Member

bors merge

@github-actions github-actions bot added ready-to-merge This PR has been sent to bors. and removed awaiting-author A reviewer has asked the author a question or requested changes. labels Sep 25, 2024
mathlib-bors bot pushed a commit that referenced this pull request Sep 25, 2024
As mentioned in #15522, the documentation uses heavily the wording "ordinal approximation", which suggests that ordinals are approximated. This PR changes it to "ordinal-indexed approximation" and highlights the indexed nature of ordinals in various places. It also fixes some apparent then vs than errors.

I appreciate any suggestions to further improve the documentation and hints for spelling mistakes.

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


Co-authored-by: Violeta Hernández <vi.hdz.p@gmail.com>
Co-authored-by: Ira Fesefeldt <public@feuervogel.me>
@mathlib-bors
Copy link
Copy Markdown
Contributor

mathlib-bors bot commented Sep 25, 2024

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors bot changed the title doc: Improve documentation of ordinal-indexed approximations [Merged by Bors] - doc: Improve documentation of ordinal-indexed approximations Sep 25, 2024
@mathlib-bors mathlib-bors bot closed this Sep 25, 2024
@mathlib-bors mathlib-bors bot deleted the ira/OrdinalApprox_doc branch September 25, 2024 12:16
dagurtomas pushed a commit that referenced this pull request Sep 25, 2024
As mentioned in #15522, the documentation uses heavily the wording "ordinal approximation", which suggests that ordinals are approximated. This PR changes it to "ordinal-indexed approximation" and highlights the indexed nature of ordinals in various places. It also fixes some apparent then vs than errors.

I appreciate any suggestions to further improve the documentation and hints for spelling mistakes.

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


Co-authored-by: Violeta Hernández <vi.hdz.p@gmail.com>
Co-authored-by: Ira Fesefeldt <public@feuervogel.me>
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. new-contributor This PR was made by a contributor with at most 5 merged PRs. Welcome to the community! ready-to-merge This PR has been sent to bors. t-logic Logic (model theory, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants