phpDocumentor / phpDocumentor/guides
Ability to specify text language in ReST
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 36
- Forks
- 22
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 24
Description
Feature request
It would be great to be able to specify text language for blocks of text in ReST.
This could for example be achieved with .. role:: language(nb) to set the language to Norwegian Bokmål (ISO code nb). An inline version of this would also be great. Maybe Example in Norwegian is :language(nb):`eksempel`
Contributor guide
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 tracing how ReST block roles and inline roles are parsed in the guides library. Compare the proposed language(nb) syntax with the existing role handling, then determine how language metadata should be represented for both forms. Done means the issue's block and inline examples can express an ISO language code such as nb.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, internationalization
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100