Page MenuHomePhabricator

API examples should explain what they do
Closed, ResolvedPublic

Description

Currently, we have only URLs, but users have to guess what they do. This bug is a prerequisite for a sensible implementation of bug 32739.


Version: unspecified
Severity: enhancement

Details

Reference
bz33147
TitleReferenceAuthorSource BranchDest Branch
Make pod and pvc watcher threads resilient to errorsrepos/releng/k8s-pvc-cleaner!26dancymain-I0fa97c028ea4b2797b3b6e26dadc8eb841cb391amain
Exit main thread if a worker thread terminatesrepos/releng/k8s-pvc-cleaner!25dancymain-I886ff2755c4fb81b42130e2e1b39dbf1033621ffmain
pvc-cleaner.py: Add #!/usr/bin/env python3repos/releng/k8s-pvc-cleaner!24dancymain-I9096c578a2731c71ba87e973d5193daff4068137main
Add --debug command line option to enable debug log levelrepos/releng/k8s-pvc-cleaner!16dancymain-I4c355d9fa586bc867ea6c23145566b80af5b878cmain
Configuring k8s-pvc-cleanerrepos/releng/gitlab-cloud-runner!305sandeepsT351478-integrate-k8s-pvc-cleanermain
cleanup unused buildkitd PVCsrepos/releng/k8s-pvc-cleaner!1sandeepsT351478-cleanup-unused-buildkitdmain
Customize query in GitLab

Related Objects

StatusSubtypeAssignedTask
ResolvedNone
ResolvedNone

Event Timeline

bzimport raised the priority of this task from to Needs Triage.Nov 22 2014, 12:04 AM
bzimport set Reference to bz33147.
bzimport added a subscriber: Unknown Object (MLST).

public function getExamples() {

		return array(
			'api.php?action=compare&fromrev=1&torev=2',
		);

}

I'm guessing we should just change it to

public function getExamples() {

		return array(
			'api.php?action=compare&fromrev=1&torev=2' => 'Does a diff between revid 1 and 2',
		);

}

Then we've just got to display it on the html dump, and via paraminfo

We know if the key is a number, we don't have a description, so we can allow fallback of no extra information for other stuff that hasn't been updated

r106439 does the core parts

Still all the documentations to update...

r106441 and r106521 I think cover the ones where descriptions are already available, and reformats them

Will log a new bug to actually do the rest of adding new example descriptions