Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix haddock documentation cross module links #19

Merged
merged 2 commits into from
May 16, 2020

Conversation

TristanCacqueray
Copy link
Contributor

@TristanCacqueray TristanCacqueray commented May 15, 2020

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

Thsi change fixes the cross module references links.

Fixes cdepillabout#17
@TristanCacqueray
Copy link
Contributor Author

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

@Vlix
Copy link
Collaborator

Vlix commented May 15, 2020

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
Copy link
Contributor Author

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
Copy link
Collaborator

Vlix commented May 15, 2020

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
Copy link
Contributor Author

That seems to work.

@cdepillabout
Copy link
Owner

This looks good to me.

@TristanCacqueray Thanks for sending this!

@Vlix Thanks for reviewing this.

@cdepillabout cdepillabout merged commit 99682b6 into cdepillabout:master May 16, 2020
@TristanCacqueray
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

hackage-docs: All links in Algorithm section go to 404.
3 participants