Recent commits to derivepassphrase.git (99ab8fabfc2746dac02e8c8a20ee25855f7e55ab)
https://git.schokokeks.org/derivepassphrase.git/tree/99ab8fabfc2746dac02e8c8a20ee25855f7e55ab
Recent commits feed provided by GitList.Reformat changelog preamble, and mention exceptions to the public APIReformat 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.
https://git.schokokeks.org/derivepassphrase.git/commit/99ab8fabfc2746dac02e8c8a20ee25855f7e55ab
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 22:53:14 +010099ab8fabfc2746dac02e8c8a20ee25855f7e55abConvert the Deprecated section to an admonitionThe 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).
https://git.schokokeks.org/derivepassphrase.git/commit/e6bd089f21c6d89687b7d9141c9135068bb7141a
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 21:46:23 +0100e6bd089f21c6d89687b7d9141c9135068bb7141aRename and expose the Buffer-ish TypeVar for prettier documentationChoose the more public name `T_Buffer`, and document this type variable,
so that the affected other types' documentation will be easier to read.
https://git.schokokeks.org/derivepassphrase.git/commit/354af83ba78530801cc5966490ecf8235295eb82
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 21:23:12 +0100354af83ba78530801cc5966490ecf8235295eb82Make the "storeroom" module's helper functions private but documented
https://git.schokokeks.org/derivepassphrase.git/commit/d58a3abf705eba597a358c323416c325aa649a02
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 21:10:38 +0100d58a3abf705eba597a358c323416c325aa649a02Move vault config exporter functions to the topFor both the `storeroom` and the `vault_native` modules, move the
exporter function to the top of the module.
https://git.schokokeks.org/derivepassphrase.git/commit/aa6e4e0a9e54fc22e0184c4ed2d6afa8e04b6a6b
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 21:10:38 +0100aa6e4e0a9e54fc22e0184c4ed2d6afa8e04b6a6bExpose the `EVP_BytesToKey` implementation at class levelThis implementation ought to appear in the documentation, which it
cannot if it stays an inner function.
https://git.schokokeks.org/derivepassphrase.git/commit/771ed1642991e626046bfbb0a5d101a9895d8f98
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 21:10:38 +0100771ed1642991e626046bfbb0a5d101a9895d8f98Fix the parsing of options to `mkdocstrings` in the reference pagesThe 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.
https://git.schokokeks.org/derivepassphrase.git/commit/f920017655d97795827b34c1fcee0143c502b225
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 21:10:38 +0100f920017655d97795827b34c1fcee0143c502b225Document internal functions of the vault config exporterAdd missing docstrings, and make the (private) methods visible.
https://git.schokokeks.org/derivepassphrase.git/commit/51223f0276ad1abdfec7b7b9fd7be2a89ea239bc
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 21:10:38 +010051223f0276ad1abdfec7b7b9fd7be2a89ea239bcConsolidate ExportVaultConfigDataFunction documentationInstead 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.)
https://git.schokokeks.org/derivepassphrase.git/commit/75ea7844415f5c78114860f7958bc39a8e4c6704
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 14:27:33 +010075ea7844415f5c78114860f7958bc39a8e4c6704Reset excluded doc files for offline documentation buildsPrimarily, this is to make draft pages such as individual changelog
entry files viewable offline.
https://git.schokokeks.org/derivepassphrase.git/commit/7034de3a91b2acbffc8ceaf3335536d8934f13de
software@the13thletter.info (Marco Ricci)Sun, 19 Jan 2025 14:18:23 +01007034de3a91b2acbffc8ceaf3335536d8934f13de