Recent commits to derivepassphrase.git (c539203b53c4317342f311d3ef2f1f9f50009e26)

Merge topic branch 'documentation-fixes' into master

2025-01-20T15:27:30+01:00

* t/documentation-fixes:
  Make `T_Buffer` type variable visible at runtime again
  Adapt "storeroom" tests to use new names for helper functions
</pre>

Make `T_Buffer` type variable visible at runtime again

2025-01-20T15:21:59+01:00

Apparently this is necessary to keep the class properly importable:
subclassing `typing.Generic` with a runtime-invisible type variable or
with a string fails.
</pre>

Adapt "storeroom" tests to use new names for helper functions

2025-01-20T15:10:25+01:00

The names changed in d58a3abf705eba597a358c323416c325aa649a02, but the
tests were still using the old names.  Oops.
</pre>

Merge topic branch 'documentation-fixes' into master

2025-01-19T23:57:06+01:00

* t/documentation-fixes:
  Add CLI messages module to documentation
  Add docstrings for CLI messages module
  Reformat changelog preamble, and mention exceptions to the public API
  Convert the Deprecated section to an admonition
  Rename and expose the Buffer-ish TypeVar for prettier documentation
  Make the "storeroom" module's helper functions private but documented
  Move vault config exporter functions to the top
  Expose the `EVP_BytesToKey` implementation at class level
  Fix the parsing of options to `mkdocstrings` in the reference pages
  Document internal functions of the vault config exporter
  Consolidate ExportVaultConfigDataFunction documentation
  Reset excluded doc files for offline documentation builds
  Remove license text from some docstrings in `derivepassphrase.cli`
  Copyedit "altered versions" license FAQ
  Fix links and other wrapping-related formatting in changelog
</pre>

Add CLI messages module to documentation

2025-01-19T23:56:09+01:00

The "submodule `cli`" will be expanded to a "subpackage `cli`", and
`_cli_msg` will be a "virtual submodule" until it is appropriately
renamed and relocated into the semantic module hierarchy.
</pre>

Add docstrings for CLI messages module

2025-01-19T23:56:09+01:00

Also rename the `_Commented` pseudo-decorator function to `commented`,
and the `_TranslatedStringConstructor` protocol (a typo) to
`TranslatableStringConstructor`.
</pre>

Reformat changelog preamble, and mention exceptions to the public API

2025-01-19T22:53:14+01:00

Reformat the changelog preamble into admonitions, instead of
a small-print disclaimer-like paragraph.  The text largely stays the
same, but for the public API, add (module, class) attributes and mention
that there are documented implementation details not considered to be
part of the public API.
</pre>

Convert the Deprecated section to an admonition

2025-01-19T21:46:23+01:00

The Deprecated section has always been non-standard, and
`mkdocstrings-python` recently removed explicit support for this.  The
recommended alternative is an explicit admonition in section notation
(i.e., a section named Warning, or Danger, or whatever), which is still
very readable in the docstring and conveys a clear intention.

References:
[mkdocstrings/python#227](https://github.com/mkdocstrings/python/issues/227).
</pre>

Rename and expose the Buffer-ish TypeVar for prettier documentation

2025-01-19T21:23:12+01:00

Choose the more public name `T_Buffer`, and document this type variable,
so that the affected other types' documentation will be easier to read.
</pre>

Make the "storeroom" module's helper functions private but documented

2025-01-19T21:10:38+01:00

</pre>