Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update documentation for UTF-8 utilities #2888

Merged
merged 1 commit into from
Jan 16, 2024

Conversation

nvmkuruc
Copy link
Collaborator

Description of Change(s)

This change adds some additional examples and corrects some errors in the documentation.

  • TfUtf8CodePointIterator::operator* suggested that it might throw an out_of_range exception, but that won't happen under the current implementation.
  • Add group_tf_String grouping for UTF-8 utilities
  • Add code examples

Fixes Issue(s)

  • I have verified that all unit tests pass with the proposed changes
  • I have submitted a signed Contributor License Agreement

@tallytalwar
Copy link
Contributor

Filed as internal issue #USD-9119

Copy link

@dsyu-pixar dsyu-pixar left a comment

Choose a reason for hiding this comment

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

Reviewed doc comment changes and had a few very minor suggestions. Otherwise, looks great!

pxr/base/tf/unicodeUtils.h Outdated Show resolved Hide resolved
pxr/base/tf/unicodeUtils.h Outdated Show resolved Hide resolved
pxr/base/tf/unicodeUtils.h Outdated Show resolved Hide resolved
pxr/base/tf/unicodeUtils.h Outdated Show resolved Hide resolved
pxr/base/tf/unicodeUtils.h Outdated Show resolved Hide resolved
@dsyu-pixar dsyu-pixar added bug and removed bug labels Jan 11, 2024
@sunyab sunyab added the usd-utf8-identifiers Issues/PRs for Unicode Identifiers in USD proposal label Jan 11, 2024
@pixar-oss pixar-oss merged commit d6c0dab into PixarAnimationStudios:dev Jan 16, 2024
5 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
usd-utf8-identifiers Issues/PRs for Unicode Identifiers in USD proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants