Clarify USCC entity categories and validation limits - #515
Open
zbl1998-sdjn wants to merge 1 commit into
Open
zbl1998-sdjn wants to merge 1 commit into
zbl1998-sdjn wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
Authority 9 terminology remains inconsistent; update the earlier SAIC wording.
Review effort: Lite
Findings: None
What changed in this PR
Documentation-only clarification of USCC entity categories, retained codes, and validation limits.
Changes:
- Documents authority-9 categories and retained-code exceptions.
- Adds official references.
- Clarifies validation scope without changing executable behavior.
| File | Summary |
|---|---|
stdnum/cn/uscc.py |
Updates module and validation documentation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The USCC module currently lists ownership and investment structures as examples of the second character's entity categories. This can lead readers to infer ownership from a prefix that instead encodes a category within a registering authority.
This documentation-only change lists the categories under authority 9, explains that the category must be read with the authority, and notes a current exception to inferring the present entity type from a retained code. It also makes the validation boundary explicit: formatting and checksum validation do not establish issuance or current registration.
Official references:
Validation:
Both checks passed. An AST comparison with docstrings removed also confirmed that executable code is unchanged. No validation rules or accepted-number behavior are changed.
Disclosure: this contribution was prepared with AI assistance while maintaining Currawong's USCI educational resources. The proposed corrections rely on the official references above.