SpikeInterface / SpikeInterface/spikeinterface
Add ticks to all arguments referenced in docstrings
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 847
- Forks
- 280
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 29
Description
@JoeZiminski @chrishalcrow @h-mayorquin
Discussion in #3068 (specifically this thread)
In the library we've been a bit inconsistent about referencing other arguments inside docstrings. We had originally agreed on ticks, so for example
def a_function(a, b):
"""
Parameters
----------
a : array
the data
b : bool
whether to scale the data in `a`
"""
Does that sound good to everyone and something to add while working on numpydoc conventions?
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 reviewing the discussion in issue #3068, especially the linked pull-request thread, to confirm the agreed numpydoc convention. Search the library docstrings for arguments referenced without ticks and update those references consistently. Done means all referenced arguments use backticks as in the example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100