Skip to content

Commit

Permalink
doc(package): clarify comment on interface DictEntry
Browse files Browse the repository at this point in the history
  • Loading branch information
DGCK81LNN committed Jan 7, 2024
1 parent 0ec6a2a commit 098f8e5
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions package/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@ export interface DictEntry {
* Useful for differentiating different senses of the same hanzi.
*
* `-` means that when converting from hanzi to shidinn, the entry is
* considered "exceptional" and should never be selected by default.
* considered "exceptional" and should not be selected by default wherever
* possible.
*
* An entry whose `hh` and `xh` are both `"-"` is a "legacy" spelling.
*/
hh?: string
/**
* Shidinn hints. Always equal to `"-"` if present, which means that when
* converting from shidinn to hanzi the entry is considered "exceptional" and
* should never be selected by default. Used to mark traditional variants of
* common hanzi.
* converting from shidinn to hanzi, the entry is considered "exceptional" and
* should not be selected by default wherever possible. Used to mark
* traditional variants of common hanzi.
*
* An entry whose `hh` and `xh` are both `"-"` is a "legacy" spelling.
*/
Expand Down

0 comments on commit 098f8e5

Please sign in to comment.