launchpadapi documentation for source package searches is terse
Bug #574835 reported by
Bryce Harrington
This bug affects 2 people
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Launchpad itself |
Fix Released
|
Low
|
Bryce Harrington | ||
Bug Description
Some of the documentation for search_tasks() parameters is incomplete. These are fairly oft-used routines so it'd be beneficial to have solid docs for them.
=== distribution_
status_upstream
status
tags - "Separated by whitespace" actually is a list
importance
milestone
milestone_
Related branches
lp:~bryce/launchpad/api-doc-fixes
- Abel Deuring (community): Approve (code)
-
Diff: 122 lines (+36/-12)2 files modifiedlib/lp/bugs/interfaces/bugtarget.py (+3/-3)
lib/lp/bugs/interfaces/bugtask.py (+33/-9)
| Changed in malone: | |
| assignee: | nobody → Bryce Harrington (bryceharrington) |
Revision history for this message
| Bryce Harrington (bryce) wrote | #1 |
| Changed in malone: | |
| status: | New → In Progress |
| importance: | Undecided → Low |
| milestone: | none → 10.05 |
Revision history for this message
| Bryce Harrington (bryce) wrote | #2 |
| Changed in malone: | |
| status: | In Progress → Fix Committed |
Revision history for this message
| Ursula Junque (ursinha) wrote Bug fixed by a commit | #3 |
| tags: | added: qa-needstesting |
| tags: |
added: qa-ok removed: qa-needstesting |
| Changed in malone: | |
| status: | Fix Committed → Fix Released |
To post a comment you must log in.
Here is a first draft at a patch. I've not yet tested it. There were a few fields I have no clue what they mean; these are marked FIXME.
On several fields where the user must specify one of a set of values, I listed the values to select from. Ideally these should show up in the Value column, but they don't and I wasn't able to spot how to slot them in there.
Note I've changed the description of tags from "Separated by whitespace." I think it might have accepted tags separated by whitespace some time in the past, but it doesn't now. Tags must be specified as a list. This is bug #569447.