TYPO3-Documentation / TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument
wrong backslash in short links on https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us//Reference/ReStructuredText/Links/Api.html
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 9
- Forks
- 123
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 23
Description
Current behavior
chapter "Links to the API with the short class name" show some class names with leading backslash.
A wrong text output with backslash above:
namespaces should always start with \MyVendor`. Use MyVendorMyExtension` for extensions
Expected behavior/output
no leading backslash for short class names
no trailing backslash in the "MyVendor" output above.
Links
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
Open the linked API documentation page and find the section “Links to the API with the short class name.” Correct the displayed class-name examples so short names have no leading backslash and the MyVendor output has no trailing backslash. Verify the rendered page matches the expected output in the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100