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

Add doc comments to icu_uniset #1154

Merged
merged 2 commits into from
Oct 12, 2021
Merged

Conversation

iainireland
Copy link
Contributor

This resolves #1030.

A few notes:

  1. I removed UnicodeSetSpanCondition, which appears to be unused, instead of documenting it.
  2. I stole most of the wording for individual properties from ICU4C / various Unicode TRs
  3. I think there's a case to be made for removing some of the properties (in particular, there are a couple that are deprecated). We can do that in a separate issue.
  4. I did not add individual doc comments for scripts or keys.

@iainireland iainireland requested a review from echeran as a code owner October 6, 2021 21:50
echeran
echeran previously approved these changes Oct 6, 2021
Copy link
Contributor

@echeran echeran left a comment

Choose a reason for hiding this comment

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

I added suggested changes regarding the Error type variants, since we still seem to use displaydoc in other components similarly, but instead just add doc strings on top. Otherwise, LGTM.

components/uniset/src/lib.rs Outdated Show resolved Hide resolved
components/uniset/src/lib.rs Outdated Show resolved Hide resolved
components/uniset/src/lib.rs Outdated Show resolved Hide resolved
components/uniset/src/lib.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@echeran echeran left a comment

Choose a reason for hiding this comment

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

LGTM!

@iainireland iainireland merged commit 651f113 into unicode-org:main Oct 12, 2021
@iainireland iainireland deleted the uniset-docs branch October 12, 2021 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add missing docs for icu_uniset
2 participants