search

cdepillabout / password

datatypes and functions for easily working with passwords in Haskell
http://hackage.haskell.org/package/password
55 stars 16 forks source link

Fix haddock documentation cross module links #19

Closed TristanCacqueray closed 4 years ago

TristanCacqueray commented 4 years ago

Fix haddock documentation cross module links

Thsi change fixes the cross module references links.

Fixes #17

Use direct module link to remove the Data.Password prefix

TristanCacqueray commented 4 years ago

This has been produced using this rule @"\([^"]*\)"@ -> @"Data.Password.\1"@

Vlix commented 4 years ago

I think it would be better for the reader to change "Bcrypt" into 'Bcrypt', so it links to the data types. This way you don't get superfluous Data.Password. in the introduction text, but still links to the modules.

TristanCacqueray commented 4 years ago

I'm not familiar with this syntax. Trying @'Data.Password.Bcrypt'@, @'Bcrypt'@ or @Data.Password.'Bcrypt'@ doesn't produce the expected result. How to get rid of the Data.Password. prefix?

Vlix commented 4 years ago

Ah right, it doesn't automatically link to modules that aren't imported. Can you try with @'Data.Password.Bcrypt.Bcrypt'@? I'm trying to get the text printed in the haddock to be Bcrypt, and link to the data Bcrypt declaration in the Data.Password.Bcrypt module.

TristanCacqueray commented 4 years ago

That seems to work.

cdepillabout commented 4 years ago

This looks good to me.

@TristanCacqueray Thanks for sending this!

@Vlix Thanks for reviewing this.

TristanCacqueray commented 4 years ago

Thank you for the suggestions and thanks for using the good first issue label :-)