JuliaConstraints / JuliaConstraints/JuliaConstraints.github.io
Generated code with docstrings needs special care
Open
Nobody has claimed this yet.
documentation
help wanted
- Dominant language
- Julia
- Stars
- 3
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
As mentioned in the title, some functions, and methods generated through metaprogramming needs some special care regarding their documentation.
Two cases:
- Functions/methods defined with a macro call preceding it, such as:
@unrolled function CompositionalNetworks.tr_in(...) - Functions/methods generated anonymously, such as the ones in USUAL_CONSTRAINTS. Can we generate documentation?
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
Begin with the two examples in the issue: the @unrolled macro before CompositionalNetworks.tr_in and the anonymous functions in USUAL_CONSTRAINTS. Locate the project entry points that generate these methods and determine how documentation is currently produced; no files or tests are named. Done should mean both cases have usable generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100