Bug#807103: python-apt-doc: Documentation describes removed functions
Control: severity -1 minor
On Sat, Dec 05, 2015 at 01:01:52PM +0100, Felix Dietrich wrote:
> Package: python-apt-doc
> Version: 1.1.0~beta1
> Severity: important
The severity is really wrong, this a minor documentation
issue.
>
> The documentation describes, as well as uses these in its examples,
> functions that are no longer part of the python-apt modules (such as
> apt_inst.debExtract). While these are usually marked as deprecated and
> the description points to the superseding functions, examples fail to
> run with errors making it harder to get started with python-apt.
>
> I am interested to work on documentation and examples or help whomever
> is currently at it, but I am uncertain how to deal with the now removed
> functions in the describing part of the documentation: Should their
> describtions simply be deleted? Moved to another section of the
> documentation archiving the old interface? Amended with a note stating
> that these functions have been removed and the versionnumber
> corresponding to the removal?
I'm fixing this right now.
BTW, I'm about to entirely rework the apt_pkg and apt_inst sections
for the 1.1 release anyway, as python-sphinx can now automatically
generate documentation from extension docstrings, so there's no point
in keeping documentation duplicated in the extension
and the RST files.
This mostly means moving the superior (longer) documentation into
the C++ files, and replacing the documentation in the rst files with
autoclass::
--
Julian Andres Klode - Debian Developer, Ubuntu Member
See http://wiki.debian.org/JulianAndresKlode and http://jak-linux.org/.
When replying, only quote what is necessary, and write each reply
directly below the part(s) it pertains to (`inline'). Thank you.
Reply to: