Skip to content
This repository has been archived by the owner on Mar 15, 2024. It is now read-only.

Better documentation for public methods #141

Open
arnaubennassar opened this issue Jun 16, 2020 · 0 comments
Open

Better documentation for public methods #141

arnaubennassar opened this issue Jun 16, 2020 · 0 comments
Milestone

Comments

@arnaubennassar
Copy link
Contributor

Improve documentation for Go methods that should be wrapped in the native layer. This documentation should include for each method:

  • Name of the method and what it does
  • list of parameters, with type description and conditions (is it optional, has constrains, ... in general information needed to validate the input of this methods)
  • optionally pre and post conditions and consequences
@arnaubennassar arnaubennassar added this to the phase3 milestone Jun 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant