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.

Sign up for GitHub

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

Jump to bottom

Document conventions #11

Open
Kagami opened this issue Feb 24, 2015 · 0 comments
Open

Document conventions #11

Kagami opened this issue Feb 24, 2015 · 0 comments
Assignees
@Kagami

Comments

@Kagami
Copy link
Member

Kagami commented Feb 24, 2015

Conventions used throughout the library should be documented in CONVENTIONS.md or somewhere in the docs. Some of them are:

  • Structure of the modules
  • Structs/messages/objects namespaces
  • decode/encode common behavior: input, output, exceptions
  • Exception-free methods like tryDecode and validate
@Kagami Kagami self-assigned this Feb 24, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Kagami Kagami

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Kagami