https://git.schokokeks.org/derivepassphrase.git/tree/master Recent commits feed provided by GitList. * 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 https://git.schokokeks.org/derivepassphrase.git/commit/7dd560cf65367d4be40fa1dc09a802ead78e88e1 software@the13thletter.info (Marco Ricci) Sun, 19 Jan 2025 23:57:06 +0100 7dd560cf65367d4be40fa1dc09a802ead78e88e1 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. https://git.schokokeks.org/derivepassphrase.git/commit/71a8045507fde0fb3734c2c12aa2c204d3cb121b software@the13thletter.info (Marco Ricci) Sun, 19 Jan 2025 23:56:09 +0100 71a8045507fde0fb3734c2c12aa2c204d3cb121b Also rename the `_Commented` pseudo-decorator function to `commented`, and the `_TranslatedStringConstructor` protocol (a typo) to `TranslatableStringConstructor`. https://git.schokokeks.org/derivepassphrase.git/commit/ff715a44ba1a9a34bc3c8fa39b12f0b433fc8536 software@the13thletter.info (Marco Ricci) Sun, 19 Jan 2025 23:56:09 +0100 ff715a44ba1a9a34bc3c8fa39b12f0b433fc8536 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. https://git.schokokeks.org/derivepassphrase.git/commit/99ab8fabfc2746dac02e8c8a20ee25855f7e55ab software@the13thletter.info (Marco Ricci) Sun, 19 Jan 2025 22:53:14 +0100 99ab8fabfc2746dac02e8c8a20ee25855f7e55ab 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). https://git.schokokeks.org/derivepassphrase.git/commit/e6bd089f21c6d89687b7d9141c9135068bb7141a software@the13thletter.info (Marco Ricci) Sun, 19 Jan 2025 21:46:23 +0100 e6bd089f21c6d89687b7d9141c9135068bb7141a Choose 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 +0100 354af83ba78530801cc5966490ecf8235295eb82 https://git.schokokeks.org/derivepassphrase.git/commit/d58a3abf705eba597a358c323416c325aa649a02 software@the13thletter.info (Marco Ricci) Sun, 19 Jan 2025 21:10:38 +0100 d58a3abf705eba597a358c323416c325aa649a02 For 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 +0100 aa6e4e0a9e54fc22e0184c4ed2d6afa8e04b6a6b This 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 +0100 771ed1642991e626046bfbb0a5d101a9895d8f98 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. https://git.schokokeks.org/derivepassphrase.git/commit/f920017655d97795827b34c1fcee0143c502b225 software@the13thletter.info (Marco Ricci) Sun, 19 Jan 2025 21:10:38 +0100 f920017655d97795827b34c1fcee0143c502b225