jsumners / jsumners/feedparser
added return types to make autocomplete and docs easier to use #14
Open
Nobody has claimed this yet.
auto-migrated
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Adding the `:return:` statement can help certain editors (and Sphinx for that
matter) to understand where to link to.
https://github.com/kurtmckee/feedparser/pull/14
Original issue reported on code.google.com by Wolphie on 4 Mar 2014 at 8:03
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 linked pull request #14 and the issue's request to add :return: statements. Identify which documented functions it covers and verify that the resulting docstrings provide return information that Sphinx and editors can use for linking and autocomplete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100