[Openstack-docs] Tool to check help text in python clients?

Andreas Jaeger aj at suse.com
Tue Sep 16 15:01:46 UTC 2014


On 09/16/2014 03:54 PM, Akihiro Motoki wrote:
> Hi,
> 
> I sometimes see client library reviews which fix the help text punctuation
> like https://review.openstack.org/#/c/119695/ .
> Does the docs team have any tools to check it?
> If so, it is nice to integrate it into pythonclient gate check.

This is unfortunately a manual process ;(, checks would be appreciated.

Reviewing patches for the CLI guide like
https://review.openstack.org/#/c/121815, I notice the changes and then
take actions if something is missing.

For nova I added a hacking check once to check that the first letter is
capitalized (
https://review.openstack.org/#/c/67647/6/nova/hacking/checks.py ). Feel
free to build on this and add further checks,

Besides the oslo.config style guide, Diane wrote a more complex one for
CLI commands but gave up to get this in ;( See here for details
https://review.openstack.org/#/c/73015/

Any help here is welcome! Thanks for asking,
Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the Openstack-docs mailing list