Recent commits to derivepassphrase.git (ff715a44ba1a9a34bc3c8fa39b12f0b433fc8536)

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>

Move vault config exporter functions to the top

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

For both the `storeroom` and the `vault_native` modules, move the
exporter function to the top of the module.
</pre>

Expose the `EVP_BytesToKey` implementation at class level

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

This implementation ought to appear in the documentation, which it
cannot if it stays an inner function.
</pre>

Fix the parsing of options to `mkdocstrings` in the reference pages

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

The options were actually never being honored because they were
incorrectly specified.

This fix also requires the submodules of `derivepassphrase.exporter` to
be included at a lower heading level (lest they aren't rendered
properly).  This was always intended that way.
</pre>

Document internal functions of the vault config exporter

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

Add missing docstrings, and make the (private) methods visible.
</pre>

Consolidate ExportVaultConfigDataFunction documentation

2025-01-19T14:27:33+01:00

Instead of duplicating the argument and exception descriptions in each
function adhering to the protocol, document the protocol, and have the
implementing function reference the protocol.  (In the current
documentation layout, this is all on the same page anyway.)
</pre>