-
Notifications
You must be signed in to change notification settings - Fork 220
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
Rework readme #198
Rework readme #198
Conversation
76184cb
to
56d5966
Compare
56d5966
to
1c709a6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we definitely need a list of all functions/data types at the top of each API doc file, similar to JSDoc. Is there any way this can be done via the template system godocdown
provides? If not, we could potentially parse the generated files for #### func ....
and #### type ....
lines, grab the description below the 'go...
' block, and pre-pend the list as a post-doc-build step. Otherwise it is not obvious what the library provides unless one scans the entire file.
README.md
Outdated
* Connection multiplexing | ||
* Types for all data schemas | ||
|
||
## Instillation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo & extra newline below
#### func (*Client) NewAuthenticatedRequestWithBytes | ||
|
||
```go | ||
func (c *Client) NewAuthenticatedRequestWithBytes(permissionType bitfinex.PermissionType, refURL string, data []byte) (Request, error) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I leave it up to you, but you may want to consider making this and a few other functions private, excluding them from the docs.
Yeah completely agree, I really dont want to make this a manual process though. Hopefully there is a nice python package for parsing markdown that I can use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm 👍
You should create an issue for pre-pending a ToC to the API docs with a script later if merged like this.
Created issue #199 |
Description:
Cleans up readme and adds new doc files
Breaking changes:
None
New features:
Fixes:
None
PR status:
Version bumped- not requiredChange-log updated- not required