OpenStack Heat

Improve docstrings for resources

Registered by Peter Razumovsky

Current Resources' descriptions are poor. Need to add docstrings to resources and expand existing for better understanding for end-users definition of resources.

Work items:
* Fix docstrings with PEP8 rules
* Add docstrings to Resource's classes where they omitted
* Improve and fix docstring where it needed
* Remove ignored rules from tox.ini

Blueprint information

Status:
Complete
Approver:
Sergey Kraynev
Priority:
Low
Drafter:
Peter Razumovsky
Direction:
Needs approval
Assignee:
Peter Razumovsky
Definition:
Approved
Series goal:
None
Implementation:
Implemented
Milestone target:
milestone icon mitaka-3
Started by
Sergey Kraynev
Completed by
Peter Razumovsky

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/docstring-improvements,n,z

Addressed by: https://review.openstack.org/218222
    Improve Resources' classes docstrings

Addressed by: https://review.openstack.org/224785
    Fix [H405] pep rule in heat/scaling

Addressed by: https://review.openstack.org/224786
    Fix [H405] pep rule in heat/engine

Addressed by: https://review.openstack.org/225028
    Fix [H405] pep rule in heat/engine/clients

Addressed by: https://review.openstack.org/225046
    Fix [H405] pep rule in heat/engine/hot

Addressed by: https://review.openstack.org/225047
    Fix [H405] pep rule in heat/engine/cfn

Addressed by: https://review.openstack.org/225048
    Fix [H405] pep rule in heat/db

Addressed by: https://review.openstack.org/225049
    Fix [H405] pep rule in heat/api

Addressed by: https://review.openstack.org/225050
    Fix [H405] pep rule in heat/cmd

Addressed by: https://review.openstack.org/225051
    Fix [H405] pep rule in heat/httpd

Addressed by: https://review.openstack.org/225677
    Fix [H405] pep rule in heat/common

Addressed by: https://review.openstack.org/225678
    Fix [H405] pep rule in heat/objects

Addressed by: https://review.openstack.org/225679
    Fix [H405] pep rule in heat/rpc

Addressed by: https://review.openstack.org/225680
    Fix [H405] pep rule in contrib

Addressed by: https://review.openstack.org/226196
    Fix [H405] pep rule in doc/source

Addressed by: https://review.openstack.org/226197
    Fix [H405] pep rule in bin

Addressed by: https://review.openstack.org/226198
    Fix [H405] pep rule in heat/resources

Addressed by: https://review.openstack.org/227380
    Fix [H405] pep rule in heat_integrationtests

Addressed by: https://review.openstack.org/227381
    Fix [H405] pep rule in heat/tests

Addressed by: https://review.openstack.org/227382
    Remove [H405] ignoring in tox.ini

Addressed by: https://review.openstack.org/233554
    [WIP] Add descriptions to all openstack resources

Gerrit topic: https://review.openstack.org/#q,topic:docstring-improvements,n,z

Addressed by: https://review.openstack.org/264906
    Add descriptions to all openstack resources (Part 2)

Addressed by: https://review.openstack.org/278530
    Add descriptions to openstack resources (Part 3)

Gerrit topic: https://review.openstack.org/#q,topic:bp/bp,n,z

Addressed by: https://review.openstack.org/284691
    Add release note for docstring improvements bp

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.
Edit subscription

Subscribers

No subscribers.