Improve WebApi documentation
Open
@greshje is already working on this.
Since Sep 10, 2024.
documentation
system
- Dominant language
- Java
- Stars
- 151
- Forks
- 183
- Avg merge
- 14m
- Merged PRs (30d)
- 2
Description
Current WebApi documentation here is sparse. Improving documentation requires updating the comments in the corresponding java code. The documentation is generated from the comments. Lack of comments makes documentation sparse.
We need to add comments to the WebApi java code. This comments should help with improving documentation for both
- REST endpoints autogenerated documentation
- ROhdsiWebApi R package
Related issues
https://github.com/OHDSI/WebAPI/issues/686
https://github.com/OHDSI/WebAPI/issues/533
https://github.com/OHDSI/WebAPI/issues/185
https://github.com/OHDSI/WebAPI/issues/197
https://github.com/OHDSI/WebAPI/issues/34
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.
Assessment
This issue has not been assessed yet.