Overview
Based on requests of some members of the API team, we will write documentation on how to use helper functions in the /utils directory.
- Create a
.md file for each file within the directory and add the explanation of what it does as well as a small snippet of code on how to use it.
- You can get a piece of code from the other parts of repo that uses the helper or your own piece of code.
- For example,
├── logger.go
├── methods.go
├── regexes.go
└── utils_test.go
becomes
├── logger.go
├── logger.md
├── methods.go
├── methods.md
├── regexes.go
├── regexes.md
├── utils_test.go
└── utils_test.md
Note
This is especially important because as the team moves forward and develops more tools and features in the future, we need to utilize these helper more.
Overview
Based on requests of some members of the API team, we will write documentation on how to use helper functions in the
/utilsdirectory..mdfile for each file within the directory and add the explanation of what it does as well as a small snippet of code on how to use it.becomes
Note
This is especially important because as the team moves forward and develops more tools and features in the future, we need to utilize these helper more.