[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

12.7 "include release notes as text" when they are large

Policy 12.7 [0] says that upstream release notes (as opposed to changelogs) should be included in packages, and if the upstream format is HTML, as both that format and gzipped plain text.

pandas has what upstream calls release notes but I'd call partway between release notes and changelog, in multiple files (one per upstream release), e.g. [1]

They are currently included in the -doc package, in HTML format as /usr/share/doc/python-pandas-doc/html/whatsnew/*.html.

Does it make sense to also concatenate them into a NEWS.gz when they are this large (it would be ~300K = ~5% of the package)?

Does this belong in the -doc package like most library documentation (Policy 12.3) or is it an exception to that like the rest of 12.7?

[0] https://www.debian.org/doc/debian-policy/ch-docs.html#changelog-files-and-release-notes
[1] https://pandas.pydata.org/docs/whatsnew/v1.0.0.html

Reply to: