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

[RFC:] Docstring for Unicode module #52761

Merged
merged 7 commits into from
Jan 9, 2024
Merged

Conversation

11happy
Copy link
Contributor

@11happy 11happy commented Jan 5, 2024

Part of #52725.
Thank you

Signed-off-by: 11happy <soni5happy@gmail.com>
Signed-off-by: 11happy <soni5happy@gmail.com>
Signed-off-by: 11happy <soni5happy@gmail.com>
@11happy
Copy link
Contributor Author

11happy commented Jan 6, 2024

Requesting review @stevengj .
Thank you

@stevengj
Copy link
Member

stevengj commented Jan 6, 2024

This is a nice addition to the manual, but it's not a docstring. A docstring is an attached to the module Unicode in the source code itself. (See the Writing Documentation section of the Julia manual.)

In particular, you would edit stdlib/Unicode/src/Unicode.jl to change the line module Unicode to something like:

"""
The `Unicode` module provides essential functionality for managing `Unicode` characters and strings.
It includes validation, category determination, normalization, case transformation, and grapheme segmentation,
enabling effective `Unicode` data handling.
"""
module Unicode

@inkydragon inkydragon added the docs This change adds or pertains to documentation label Jan 6, 2024
Signed-off-by: 11happy <soni5happy@gmail.com>
Signed-off-by: 11happy <soni5happy@gmail.com>
Signed-off-by: 11happy <soni5happy@gmail.com>
@lgoettgens
Copy link
Contributor

With this PR, there is a duplication of information on the docs page: The exact same sentence is first shown as a text, and then as the docstring of the Unicode module. Maybe there is a way to reduce that to one?

@11happy
Copy link
Contributor Author

11happy commented Jan 7, 2024

I think I can change the Docs one or should I remove it?

@stevengj
Copy link
Member

stevengj commented Jan 8, 2024

I don't think there is an easy way to write the sentence only once, so you should just leave it as-is.

Signed-off-by: 11happy <soni5happy@gmail.com>
@stevengj stevengj marked this pull request as ready for review January 8, 2024 12:44
@stevengj stevengj added the merge me PR is reviewed. Merge when all tests are passing label Jan 8, 2024
@stevengj stevengj merged commit b4d857b into JuliaLang:master Jan 9, 2024
@IanButterworth IanButterworth removed the merge me PR is reviewed. Merge when all tests are passing label Jan 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants