SciML / SciML/PDESystemLibrary.jl
Find a way for the docstrings to apply directly to the created system objects, with programatically edited docstrings for different ICs
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 26
- Forks
- 6
- Avg merge
- 4h 21m
- Merged PRs (30d)
- 11
Description
At the moment docstrings apply to generator functions for the systems, but it would be better if they applied to the objects themselves. Doing this previously caused an error that I was not able to resolve, so would like to hear if anyone has a solution other than just storing them in a field.
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 by inspecting the generator functions and reproducing the earlier error that occurred when applying docstrings to the created system objects. The work is done when object docstrings support programmatically edited text for different ICs without relying only on storing the text in a field.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100