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.

Sign up for GitHub

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

Jump to bottom

Check dead doc links / API parity on CI #7

Open
martijnbastiaan opened this issue Dec 7, 2020 · 0 comments
Open

Check dead doc links / API parity on CI #7

martijnbastiaan opened this issue Dec 7, 2020 · 0 comments
Labels
enhancement New feature or request
Milestone
0.1

Comments

@martijnbastiaan
Copy link
Member

martijnbastiaan commented Dec 7, 2020 •
edited
Loading

  • This project's CI enforces a 100% documentation coverage for the library to be published on Hackage. Perhaps we could use something like https://pypi.org/project/deadlinks/ to enforce non-broken links too.
  • It would be nice to enforce API parity between Protocols.Df and Protocols.Df.Simple (where possible).
@martijnbastiaan martijnbastiaan added the enhancement New feature or request label Dec 7, 2020
@martijnbastiaan martijnbastiaan added this to the 0.1 milestone Dec 7, 2020
@martijnbastiaan martijnbastiaan changed the title Check dead doc links on CI Check dead doc links / API parity on CI Dec 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
0.1
Development

No branches or pull requests
1 participant
@martijnbastiaan