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

Improve documentation #21

Merged
merged 1 commit into from Mar 7, 2019

Conversation

Projects
None yet
2 participants
@Carpetsmoker
Copy link
Contributor

Carpetsmoker commented Mar 7, 2019

This improves various parts of the godoc and README. Some docs could be
improved a bit more, but this should fix most of the grammar oddities.

I also improved the verbiage of errors, as some were a bit awkwardly
worded as well. I also changed some of the formatting specifiers from
\"%v\" to %q, as that looks a bit neater. Also use fmt.Errorf()
inside newError(), as every invocation of newError() was using it.
It also adds the checked error where applicable, which is more detailed
than "not valid".

I used my own judgement in changing some stuff around (e.g. putting the
usage example higher in the README). Feel free to point out if you don't
like some part and I can just change it back.

I unexported some types that serve no purpose for users of formam as far
as I can see to clean up the godoc a bit; I changed the tests to run
from another package (formam_test) to make sure it still works well from
another package (sometimes exporting is needed in decoding for
visibility, e.g. in json).

Fixes #1

Improve documentation
This improves various parts of the godoc and README. Some docs could be
improved a bit more, but this should fix most of the grammar oddities.

I also improved the verbiage of errors, as some were a bit awkwardly
worded as well. I also changed some of the formatting specifiers from
`\"%v\"` to `%q`, as that looks a bit neater. Also use `fmt.Errorf()`
inside `newError()`, as every invocation of `newError()` was using it.
It also adds the checked error where applicable, which is more detailed
than "not valid".

I used my own judgement in changing some stuff around (e.g. putting the
usage example higher in the README). Feel free to point out if you don't
like some part and I can just change it back.

I unexported some types that serve no purpose for users of formam as far
as I can see to clean up the godoc a bit; I changed the tests to run
from another package (formam_test) to make sure it still works well from
another package (sometimes exporting is needed in decoding for
visibility, e.g. in json).

Fixes #1
@Carpetsmoker

This comment has been minimized.

Copy link
Contributor Author

Carpetsmoker commented Mar 7, 2019

@emilgpa

This comment has been minimized.

Copy link
Contributor

emilgpa commented Mar 7, 2019

Wow. Excellent! Thanks you very much!

@emilgpa emilgpa merged commit 79ffecd into monoculum:master Mar 7, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@Carpetsmoker Carpetsmoker deleted the Carpetsmoker:doc branch Mar 7, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.