Indicate expected import in docstrings
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 384
- Forks
- 124
- Avg merge
- 22h 28m
- Merged PRs (30d)
- 10
Description
When showing docstrings in Verso, documentation authors should be able to annotate a name with the import that users should use (e.g. import Foo.Bar rather than import Foo.Bar.Basic).
This could look like:
{docstring Foo.Bar.thing (import := Foo.Bar)}
Verso should also validate that the module in which the name is defined is a transitive dependency of the imported module.
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 by locating Verso's docstring syntax handling and the module dependency validation logic. Confirm how the proposed import annotation should be parsed and how transitive dependencies are represented; done means valid annotations are accepted and invalid module relationships are rejected.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100