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

Document the strings API #17

Open
rillig opened this issue May 2, 2015 · 0 comments
Open

Document the strings API #17

rillig opened this issue May 2, 2015 · 0 comments
Assignees

Comments

@rillig
Copy link
Contributor

rillig commented May 2, 2015

It is difficult for a new developer to grasp why so many stringer_t types exist and what they are for. Therefore the API should either be trimmed down to the strictly necessary parts, or it should be documented by giving some typical examples of use. The documentation should be at the stringer_t data type and be cross-referenced from the other data types.

Maybe these other data types can even be made private, so that they are not part of the API.

@LBiv LBiv self-assigned this Jul 20, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants