How to localize TSDoc content?
Open
Nobody has claimed this yet.
needs design
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
export interface IField {
/**
* @language-tag en-US
* @description name of fields
*/
/**
* @language-tag zh-Hans-CN
* @description 字段名
*/
name: string;
}
it will help us to generate documents for multi language.
We can found language tags rfc in Tags for Identifying Languages and search tag in IANA Language Subtag Registry
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the TSDoc syntax and specification context, then read the linked RFC 4646 and IANA Language Subtag Registry references. Determine how localized descriptions should be represented and documented; done means the behavior and supported language-tag conventions are clearly specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, internationalization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100