-
Notifications
You must be signed in to change notification settings - Fork 75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DXCDT-242: Documenting connections options for all strategies via examples #383
DXCDT-242: Documenting connections options for all strategies via examples #383
Conversation
Codecov ReportBase: 86.91% // Head: 86.74% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #383 +/- ##
==========================================
- Coverage 86.91% 86.74% -0.18%
==========================================
Files 40 41 +1
Lines 8593 8730 +137
==========================================
+ Hits 7469 7573 +104
- Misses 863 890 +27
- Partials 261 267 +6
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
🔧 Changes
This PR introduces more coverage of connection options documentation. This comprehensive coverage now includes examples for all connection strategies and each example includes all configurable options. This work was done in response to reported confusion regarding connections documentation, see: #365.
Because of the way that that the documentation was generated, this was the easiest way to document and demonstrate the usage of all connection strategies. More ideal approaches were discussed but were deemed too manual and susceptible to drift. So for now, this will serve as a first pass with the possibility of more improvements over time if necessary.
📚 References
Relevant issue: #365
🔬 Testing
Manually tested by applying examples against a live tenant.
📝 Checklist