Skip to content

docs: revise and expand ImmutableDict docstring. #58445

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

rfritz
Copy link

@rfritz rfritz commented May 17, 2025

I had difficulty using the ImmutableDict type based on the documentation. After studying the code and reviewing advice on the Discourse site, I wrote this. This is the second version; I have made it match the style of the existing dictionary documentation and removed the tutorial content.

@giordano
Copy link
Contributor

Thanks for the contribution, but can we please have a more descriptive title? The current one is rather cryptic.

@giordano giordano added the docs This change adds or pertains to documentation label May 17, 2025
@rfritz
Copy link
Author

rfritz commented May 18, 2025

Ooops! That was pretty obscure. I've updated the commit message on dict.jl following the procedure (and wincing at the warnings) given in "Changing a commit message." Will that serve?

@giordano giordano changed the title Imdictdoc collections.md: add ImmutableDict to list of dictionary types May 18, 2025
@giordano giordano changed the title collections.md: add ImmutableDict to list of dictionary types docs: add ImmutableDict to list of dictionary types May 18, 2025
@giordano
Copy link
Contributor

Ok, I changed the title of the PR based on commit message. As reference for next time, you can do it by clicking on the "Edit" button in the top right corner of the page.

@rfritz rfritz changed the title docs: add ImmutableDict to list of dictionary types docs: revise and expand ImmutableDict docstring. May 18, 2025
@rfritz
Copy link
Author

rfritz commented May 18, 2025

oh, duh. thanks for the correction and information.

@nsajko nsajko added the collections Data structures holding multiple items, e.g. sets label May 18, 2025
Copy link
Contributor

@MasonProtter MasonProtter left a comment

Choose a reason for hiding this comment

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

Just some minor comments / tweaks

Co-authored-by: Mason Protter <mason.protter@icloud.com>
@LilithHafner
Copy link
Member

Thanks for continuing to work on this, @rfritz! FYI, in the future you can continue using the previous pr and don't have to open a new one, that way all the conversation stays in the same place. We can keep working here now, though :)

Co-authored-by: Mason Protter <mason.protter@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
collections Data structures holding multiple items, e.g. sets docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants