docs: state assumption in readme examples #29
+2
−0
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
This clearly documents the assumption, made by the examples, that the user is setting the `NODE_ENV` environment variable to control their application. While this may be standard practice, clarity in documentation is rarely a bad thing! Signed-off-by: Dustin Popp <dustinpopp@ibm.com>
bjohansebas
approved these changes
Nov 7, 2024
|
@UlisesGascon do you mind taking a look? |
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.
This clearly documents the assumption, made by the examples, that the user is setting the
NODE_ENVenvironment variable to control their application. While this may be standard practice, clarity in documentation is rarely a bad thing!Resolves #28