opal icon indicating copy to clipboard operation
opal copied to clipboard

docs(config): add descriptions to all configuration variables and tests

Open onyedikachi-david opened this issue 1 year ago • 3 comments

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.

onyedikachi-david avatar Oct 11 '24 15:10 onyedikachi-david

Deploy Preview for opal-docs canceled.

Name Link
Latest commit f38be075a4f4d6e4264c3e29d6d8cfcc2816b220
Latest deploy log https://app.netlify.com/sites/opal-docs/deploys/670cb6503eea510008cf6b54

netlify[bot] avatar Oct 11 '24 15:10 netlify[bot]

The PR is ready for review @gemanor

onyedikachi-david avatar Oct 12 '24 12:10 onyedikachi-david

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.

onyedikachi-david avatar Oct 14 '24 06:10 onyedikachi-david

@gemanor Please review.

onyedikachi-david avatar Oct 25 '24 12:10 onyedikachi-david

Hi @gemanor, I don't know if you have got time to review this.

onyedikachi-david avatar Nov 17 '24 15:11 onyedikachi-david

Hi @gemanor, I don't know if you have got time to review this.

onyedikachi-david avatar Nov 17 '24 15:11 onyedikachi-david

@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 avatar Dec 24 '24 18:12 onyedikachi-david

@onyedikachi-david send like another PR was already merged for this. Sorry I didn't notice prior to my review. Best

izzywdev avatar Dec 25 '24 19:12 izzywdev

Okay

onyedikachi-david avatar Dec 27 '24 15:12 onyedikachi-david