search

haskell-servant / servant-multipart

Support for file uploads in multipart/form-data for servant
https://hackage.haskell.org/package/servant-multipart
40 stars 37 forks source link

Add HasDocs instance #11

Closed cdepillabout closed 7 years ago

cdepillabout commented 7 years ago

This PR adds a HasDocs instance for MultipartForm.

It also adds a ToMultipartSample class so that users can easily add documentation for their types. This is similar to the ToSample class from servant-docs.

The output markdown created by the HasDocs instance can be seen here.

This PR also adds a stack.yaml to make development easier for people using stack. However, if you don't want a stack.yaml in this repository, let me know and a I'll remove it!

Closes #10.

alpmestan commented 7 years ago

I don't mind having stack.yaml files around for those who prefer stack don't worry. The PR looks good to me! @phadej objections?

cdepillabout commented 7 years ago

@phadej Any thoughts about this HasDocs instance for MultipartForm?

alpmestan commented 7 years ago

9 days is enough to chime in. Merging this. We can still tweak those docs instances later if there's a problem.

cdepillabout commented 7 years ago

@alpmestan Thanks!