mattermost / mattermost/mattermost-developer-documentation
Help Wanted: Default parameters are not correctly rendered in plugin registry methods
Open
Nobody has claimed this yet.
difficulty/2:Medium
Help Wanted
Type/Bug
Up For Grabs
- Dominant language
- CSS
- Stars
- 90
- Forks
- 460
- Avg merge
- 9d 23h
- Merged PRs (30d)
- 2
Description
See, for example, registerAdminConsoleCustomSetting, where showTitle is missing:
This happens because the default parameters have a different structure in the AST returned by the parser.
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 from the documentation page for registerAdminConsoleCustomSetting and trace the parser or renderer that produces the plugin registry method reference. Compare how ordinary and default parameters are represented in the AST, using the missing showTitle example as the reproduction. Done means default parameters appear correctly in the generated reference.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100