Improve documentation - Githubissues

PSPDFKit-labs / bypass

Bypass provides a quick way to create a custom plug that can be put in place instead of an actual HTTP server to return prebaked responses to client requests.

https://hex.pm/packages/bypass

MIT License

964 stars 111 forks source link

Improve documentation #102

Closed thiamsantos closed 4 years ago

thiamsantos commented 4 years ago

Motivation

Ref #98

Proposed solution

Use the approach mentioned at #98 to use part of the README as moduledoc of the main module.
Add typespec for the public functions
Move the docs of each function to their own @doc blocks

ream88 commented 4 years ago

Thx a lot, merging now!