[DOCS] http.query isn't documented effectively
Open
Nobody has claimed this yet.
bug
doc-param-missing
doc-rework
documentation
severity-high
time-estimate-sprint
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
The documentation for modules.http.query only explains one of the 49 parameters. Instead it tries to link to utils.http.query, which doesn't work.
Suggested Fix
Some options:
- Copy the docstring from
utils.http.querytomodules.http.query, ensure it is complete, and reverse the direction of the reference. - Get the documentation to generate for the
utils.httpmodules and ensure the link works correctly.
Type of documentation
Salt modules
Location or format of documentation
https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.http.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
Start with the Salt modules documentation at the linked http module page and compare modules.http.query with the utils.http.query docstring. Determine whether the docstring should be copied or generated for the utils.http modules; done means all 49 parameters are documented and the reference link works.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100