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

doc: Improve docstrings around Array.mk,.data,.toList #2771

Merged
merged 2 commits into from
Nov 29, 2023

Conversation

@github-actions github-actions bot added the toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN label Oct 26, 2023
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Oct 26, 2023
@leanprover-community-mathlib4-bot
Copy link
Collaborator

leanprover-community-mathlib4-bot commented Oct 26, 2023

@leanprover-community-mathlib4-bot leanprover-community-mathlib4-bot added the builds-mathlib CI has verified that Mathlib builds against this PR label Oct 27, 2023
@nomeata
Copy link
Contributor Author

nomeata commented Nov 28, 2023

On Zulip there was some disagreement which function should be recommended to be used, without conclusion. To not have this PR (which makes no such recommendation either way) sitting around for much longer, I’ll merge it if noone complains. Further improvements are still possible of course.

@nomeata nomeata marked this pull request as ready for review November 28, 2023 10:02
@nomeata nomeata added the will-merge-soon …unless someone speaks up label Nov 28, 2023
src/Init/Prelude.lean Outdated Show resolved Hide resolved
Co-authored-by: Mario Carneiro <di.gama@gmail.com>
@nomeata
Copy link
Contributor Author

nomeata commented Nov 29, 2023

@digama0 do you overall agree with these changes?

@digama0
Copy link
Collaborator

digama0 commented Nov 29, 2023

Regarding the main question, my opinion is as mentioned on zulip - we should rename data to toList and toList to toListImpl - but as a pure docs PR the docstrings look fine to me.

@nomeata nomeata added this pull request to the merge queue Nov 29, 2023
Merged via the queue into leanprover:master with commit 34264a4 Nov 29, 2023
17 checks passed
@nomeata nomeata deleted the doc-array-toList branch November 29, 2023 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
builds-mathlib CI has verified that Mathlib builds against this PR toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN will-merge-soon …unless someone speaks up
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants