Update manuals according to Drivers 5.0 changes #335
Conversation
…ommon-content` updates related to 5.0.
…tent` since that sections are not included, and this avoids a useless diff.
There was a problem hiding this comment.
Thanks @stefano-ottolenghi
Just a couple of small things to look at.
| @@ -1486,19 +1459,13 @@ include::{python-examples}/test_config_max_retry_time_example.py[tags=config-max | |||
|
|
|||
| # tag::configuration-TrustStrategy[] | |||
|
|
|||
| `TrustStrategy`:: | |||
| `TrustedCertificates`:: | |||
There was a problem hiding this comment.
The example in this renamed section still uses TrustStrategy
I guess if this is an error, it's not a documentation fix, and as such shouldn't delay this PR.
There was a problem hiding this comment.
tl;dr - It is a wrong label anyway, I can restore it to TrustStrategy if we want to avoid a pointless diff.
Right, so this is an annoying bit that basically has to do with the fact that different drivers have different option names, so that TrustedCertificates (or TrustStrategy, for that matter) is inaccurate for them all. This problem applies to all configuration options in that page.
What happened is that I started reviewing from the Python manual, which calls is trusted_certificates, so I renamed the section to TrustedCertificates - still wrong, but at least with the right words. Then I discovered that each language has it different (for ex, in the .NET screenshot here, it is WithTrustManager), so the correction is pointless. IIRC the Java driver is the only one having TrustStrategy, which would explain at least historically why that section had that name. Then Drivers diverged and we kept the same naming for all of them.
There was a problem hiding this comment.
maybe this is a good case for bringing this content into the individual language folders, and out of the common-content folder?
I think that could be done in another PR though, and shouldn't hold us up on this PR.
There was a problem hiding this comment.
Yeah, I would defer this to the re-design of the manuals :)
Co-authored-by: David Oliver <[email protected]>
|
Related to |
Added a note about
execute_read/execute_writereplacingread_transaction/write_transaction, or their language-specific counterparts.Made the
TrustedCertificatesconfig section language-dependent, and specify the possible values for each language.Removed references to 3.x, except minor informative reminders.
Added note about the exception property
CanBeRetried.Mention Async Python driver.
Waiting for Drivers team to update Java, Javascript and .NET examples about
execute_read/write.