greenwave

#39 issue #36: fix the docs
Merged by mjia. Opened by mjia.
mjia/greenwave fix_docs  into  master

Download 39.patch
no initial comment

Hmm I wonder if there is some nice way we can take the example requests/responses in the docs and run them as tests, like doctest... to avoid this kind of mistake, where the examples in the docs don't reflect reality.

But anyway, :+1:

Can you please also double-check that there are no other errors in the example responses?

LGTM.

FWIW, Sphinx does support running doctests. I would recommend considering it, but I think it'd be fair to consider that a separate effort (and separate PR).

Yeah, I've filed a new issue #41 for it.

Pull-Request has been merged by mjia
Metadata
None
No Tags
Static archive. pagure.io was sunset in 2026; this is a read-only snapshot.
Red Hat Logo

Fedora is sponsored by Red Hat. Learn more about the relationship between Red Hat and Fedora »

© Red Hat, Inc. and others.