docs: Corrected the variables and code snippets#50
Open
sellisd wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR corrects variable naming inconsistencies in the README documentation to match the actual code implementation. The changes standardize all input variable names from camelCase to lowercase formatting.
- Updated all input parameter names from camelCase to lowercase (e.g.,
serverHostname→serverhostname) - Updated all code examples to use the corrected lowercase variable names
- Ensures documentation matches actual code implementation for copy-paste functionality
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) |
The examples in the readme file had variables in camelCase while in the code they are all smallcase. I modified the readme to match the code, so now a user can copy paste the code from the readme and have a working example directly. Signed-off-by: Diamantis Sellis <diamantis.sellis@cosmotech.com>
This file contains hidden or 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
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.
The examples in the readme file had variables in
camelCase while in the code they are all smallcase. I modified the readme to match the code, so now
a user can copy paste the code from the readme and have a working example directly.