Incorrect documentation of field_order
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 346
- Forks
- 113
- PR merge metrics
- No merged PRs in 30d
Description
The attribute webtest.forms.Form.field_order that returns a list of pairs of field names and field objects does not match the documentation that says:
Ordered list of field names as found in the html.
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
Open the API documentation for webtest.forms.Form.field_order and compare its wording with the attribute behavior described in this issue. Update the field_order documentation to accurately describe its returned pairs of field names and field objects; done means the published text no longer says it returns only field names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100