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

Improved hex docs #115

Open
orestis opened this issue Jan 17, 2017 · 3 comments
Open

Improved hex docs #115

orestis opened this issue Jan 17, 2017 · 3 comments

Comments

@orestis
Copy link

orestis commented Jan 17, 2017

The current hex docs are quite bare: Only a minimum API reference, empty modules (Poison.Encoder, Poison.Pretty) and no examples of what options can be passed to encode etc.

It would be nice to expose the current README in the hex docs, to start with. Thanks!

@orestis orestis changed the title Improved ex docs Improved hex docs Jan 17, 2017
@zorbash
Copy link

zorbash commented Feb 21, 2017

I'm willing to submit a PR for this. Currently I'm looking for a way to pretty encode a value using
Poison.encode/2 and the docs

def encode(value, options \\ [])                  

Encode a value to JSON.

┃ iex> Poison.encode([1, 2, 3])
┃ {:ok, "[1,2,3]"}

One shouldn't have to have to look at the code to figure out the available options.

@cthree
Copy link

cthree commented Feb 27, 2017

I'm also willing to take the time to write some doc blocks. For such a popular module it has uncharacteristically sparse docs. It's a significant barrier to entry.

@scmx
Copy link

scmx commented Nov 13, 2017

I'm also willing to help improving the docs. I see that there's already a related PR open #123

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

No branches or pull requests

4 participants