haskell-cryptography/botan

Documentation readability suggestion

Closed this issue · 3 comments

Vlix commented

https://github.com/apotheca/botan/blob/72efa8573d3aac91e14001ef79164d5cf89d1244/botan-bindings/src/Botan/Bindings/Bcrypt.hs#L44

This is weird to read: password the password cf. haddock reference

Could I recommend formatting it more like:

 -> ConstPtr CChar -- ^ @password@: the password
ldillinger commented

This suggestion has been applied and will be in the coming release update.

  • ❤️1
Vlix commented

Everywhere, or only in the Bcrypt module?
(I noticed it's like this in a lot of modules)

ldillinger commented

Everywhere! In botan-bindings and botan-low. I did have to go with __varname__ instead of @varname@ because the monospace was taking up gobs of extra height if it was the only content:

Screenshot 2024-02-13 at 2 26 08 PM

So I went with bold instead.

  • ❤️1