Document all BaseProxy methods in the contributor guide

Bug #1437533 reported by Brian Curtin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack SDK
Confirmed
Low
Unassigned

Bug Description

By default, private methods are ignored by autodoc, but we need to make sure some of them from BaseProxy are documented under the developer guide. We should ensure that they are both documented for contributors, but demarcated in a way that they're still considered implementation details so we can best serve the public interface.

Changed in python-openstacksdk:
status: New → Confirmed
milestone: none → 1.0
tags: added: documentation
Changed in python-openstacksdk:
importance: Medium → Low
Changed in python-openstacksdk:
milestone: 1.0 → none
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.