WerWolv / WerWolv/PatternLanguage
`plcli doc` generate doc for files included with the `import`statement
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 275
- Forks
- 75
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 10
Description
Description of the Issue
plcli doc generate doc for files included with the importstatement
https://github.com/WerWolv/Documentation/commit/bc5dba28a219ea5b4094fbe754ab516c3162fce6
Steps to Reproduce the Issue
Look at the doc generated by the github workflow.
For example libraries/type/color.pat.md generated from includes/type/color.pat
Expected Behavior
Each generated document file should only contain doc for elements in the source file.
Actual Behavior
The generated doc also contain doc from includes/std/core.pat and includes/std/mem.pat.
Debug Information
Edit 2024-07-13 Fix the broken link
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 with the plcli doc command and compare its output for includes/type/color.pat with the generated libraries/type/color.pat.md document. Trace how imported includes/std/core.pat and includes/std/mem.pat are included, then verify that each generated document contains only documentation for elements in its source file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- cli, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100