Suggestion for docs, use named parameters #334
Draft
Conversation
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
I think it's much easier to read if we use named parameters in our example sql code, especially with functions that have many parameters.
1e47261 to
9b23b51
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
❌ Your project status has failed because the head coverage (80.50%) is below the target coverage (90.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## TDE_REL_17_STABLE #334 +/- ##
==================================================
Coverage 80.49% 80.50%
==================================================
Files 22 22
Lines 2605 2606 +1
Branches 398 399 +1
==================================================
+ Hits 2097 2098 +1
Misses 430 430
Partials 78 78
🚀 New features to boost your workflow:
|
nastena1606
approved these changes
May 15, 2025
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.
I think it's very hard to quickly see what's going on with long lists of parameters to functions, so in our documentation we should instead use the named parameter syntax to make it clearer what's going on.
I updated one file just to show an example of what I mean, take a look at wal-encryption.md