Generated documentation for `Lems` root element does not include `Include`
Open
Nobody has claimed this yet.
bug
- Dominant language
- Java
- Stars
- 11
- Forks
- 11
- Avg merge
- 8h 6m
- Merged PRs (30d)
- 1
Description
As title. Can be confirmed in the generated docs:
http://lems.github.io/LEMS/elements.html
The paper also notes that Lems should have Include (see figure 2 also).
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
Compare the generated documentation at http://lems.github.io/LEMS/elements.html with the paper's figure 2 and its note that the Lems root element should have Include. Trace how the Lems element's documentation is generated, and consider the issue done when the generated root-element documentation lists Include.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100