add documentation on COUCH2PG_USERS_META_DOC_LIMIT and add safeNum safety #100
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mrsarm
suggested changes
Jul 6, 2021
README.md
Outdated
| @@ -23,6 +23,7 @@ The supported environment variables are: | |||
| | COUCH2PG_SLEEP_MINS | Number of minutes between synchronization | | |||
| | COUCH2PG_DOC_LIMIT | Number of documents cht-couch2pg fetches from CouchDB everytime | | |||
| | COUCH2PG_RETRY_COUNT | Number of times cht-couch2pg will retry synchronizing documents from CouchDB after experiencing an error | | |||
| | COUCH2PG_USERS_META_DOC_LIMIT | Number of documents from users-meta database that cht-couch2pg fetches from CouchDB everytime | | |||
There was a problem hiding this comment.
The description seems incomplete, making the variable to look like it sets a limit on how much documents are fetched in total or in total in a batch, while in reality the value is set to limit the number of documents per fetch. A good description I found is here, and would be nice to also add in the description what is the default value taken when the variable is not set.
Also would be nice if you can add in the documentation what is the default value taken in the rest of the variables or at least where to check the default values (inquirer.js).
1yuv
approved these changes
Jul 8, 2021
This was
linked to
issues
Aug 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation about the
COUCH2PG_USERS_META_DOC_LIMITenvironment variable and add safeNum safety check