julia icon indicating copy to clipboard operation
julia copied to clipboard

docs: revise and expand `ImmutableDict` docstring.

Open rfritz opened this issue 8 months ago • 6 comments

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.

rfritz avatar May 17 '25 03:05 rfritz

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

giordano avatar May 17 '25 08:05 giordano

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?

rfritz avatar May 18 '25 00:05 rfritz

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.

giordano avatar May 18 '25 00:05 giordano

oh, duh. thanks for the correction and information.

rfritz avatar May 18 '25 00:05 rfritz

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 :)

LilithHafner avatar May 20 '25 12:05 LilithHafner

Is there anything else I need to do on this? Or is it just a matter of waiting until it's picked up in a release?

rfritz avatar Jun 10 '25 23:06 rfritz