phpDocumentor / phpDocumentor/guides
Ability to specify text direction in ReST
Open
Nobody has claimed this yet.
feature
triage
- 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 direction in sections of text.
This could for example be achieved with .. role:: rtl (for blocks). Maybe an inline option should also be possible? For example Example in Arabic is :rtl:`مثال`
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
The issue names ReST sections and the proposed rtl block role plus an inline :rtl: role, but no files or tests. Start by locating the ReST parsing path and determine how both forms should represent text direction, including the Arabic example. Done means the supported syntax and its expected behavior are defined and covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation, internationalization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100