DOCSP-32154: collStats deprecation #431
Conversation
source/whats-new.txt
Outdated
| @@ -32,6 +32,10 @@ Learn what's new in: | |||
| Upcoming Breaking Changes | |||
| ------------------------- | |||
|
|
|||
| - The ``getStats()`` and ``isCapped()`` instance methods of the | |||
| ``DBCollection`` class are deprecated. The corresponding server commands are | |||
| deprecated in MongoDB v6.2 and later. To learn how to retrieve this | |||
There was a problem hiding this comment.
S: improve clarity
| deprecated in MongoDB v6.2 and later. To learn how to retrieve this | |
| deprecated in MongoDB Server version 6.2 and later. To learn how to retrieve this |
There was a problem hiding this comment.
same for the sentence in what's new
There was a problem hiding this comment.
Thanks for raising this. A couple years ago, our team discussed representing MongoDB server and versions in this format, but it hasn't been closely followed. This is currently consistent with the other Upcoming Breaking Changes item and most of the "What's New" entries in the Java docs, so I think it might be better to leave for now.
I purposely haven't commented on instances in which you've represented it as the suggested version since I don't think it's necessary or high value to propagate to all driver documentation, but rather to stay consistent within a docs set.
There is some existing style guide guidance on versions, which I think applies to Server docs. This specifically advises against using "version X.X". However, the entry does not seem to take into consideration the existence of any other product nor version naming used by drivers.
source/whats-new.txt
Outdated
| :manual:`$collStats (aggregation) </reference/operator/aggregation/collStats/>` | ||
| Server documentation. |
There was a problem hiding this comment.
S; follow convention
| :manual:`$collStats (aggregation) </reference/operator/aggregation/collStats/>` | |
| Server documentation. | |
| :manual:`$collStats (aggregation) </reference/operator/aggregation/collStats/>` | |
| documentation in the Server manual. |
There was a problem hiding this comment.
I know we had a discussion around capitalization, but didn't know that we had to refer to it as such rather than Server documentation. I'll change it to "$collStats Server manual entry" since "documentation in the ... manual" is redundant.
ccho-mongodb
requested review from
a team and
jyemin
and removed request for
a team
|
|
||
| .. code-block:: java | ||
|
|
||
| collection.aggregate(Arrays.asList( |
There was a problem hiding this comment.
Just checking whether you tested this, since I have not.
There was a problem hiding this comment.
Yes, I tested it. I posted valid code from which I extracted this snippet in our Slack channel when asking whether there was a more idiomatic way to get that data.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-32154
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/java/docsworker-xlarge/DOCSP-32154-collstats/whats-new/#upcoming-breaking-changes
Self-Review Checklist