opal
opal copied to clipboard
docs(config): add descriptions to all configuration variables and tests
Closes #40
/claim #40
Changes proposed
- Added descriptions to all configuration variables in OpalClientConfig
- Added descriptions to all configuration variables in OpalServerConfig
- Added descriptions to all configuration variables in OpalCommonConfig
- Created a test to ensure all configuration variables have descriptions
Check List (Check all the applicable boxes)
- [x] I sign off on contributing this submission to open-source
- [x] My code follows the code style of this project.
- [ ] My change requires changes to the documentation.
- [ ] I have updated the documentation accordingly.
- [x] All new and existing tests passed.
- [x] This PR does not contain plagiarised content.
- [x] The title of my pull request is a short description of the requested changes.
Deploy Preview for opal-docs canceled.
| Name | Link |
|---|---|
| Latest commit | f38be075a4f4d6e4264c3e29d6d8cfcc2816b220 |
| Latest deploy log | https://app.netlify.com/sites/opal-docs/deploys/670cb6503eea510008cf6b54 |
The PR is ready for review @gemanor
It is a good start, but the descriptions need to be much more descriptive. I left two examples (but there are more). Please fix them, and commit again.
Done.
@gemanor Please review.
Hi @gemanor, I don't know if you have got time to review this.
Hi @gemanor, I don't know if you have got time to review this.
@iwphonedo, I thought it's closed. Even though I open a PR first and my re-review request was pending when the other PR was opened. Should I reopen?
@onyedikachi-david send like another PR was already merged for this. Sorry I didn't notice prior to my review. Best
Okay