DOCSP-49849 - Collation #628

mongoKart · 2025-05-07T19:35:38Z

I wanted to incorporate this into the Server docs but it didn't fit there neatly.

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-49849

Staging Links

logging-and-monitoring/change-streams

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?

netlify · 2025-05-07T19:35:42Z

✅ Deploy Preview for docs-csharp ready!

Name	Link
🔨 Latest commit	`ed9d6bc`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-csharp/deploys/681d219c244ab900087c697b
😎 Deploy Preview	https://deploy-preview-628--docs-csharp.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

rachel-mack

I think you could improve this:

rachel-mack · 2025-05-08T15:06:05Z

source/includes/collation.rst

+     - ``Locale`` 
+
+   * - ``alternate``
+     - | Optional. Specifies whether the driver considers whitespace and punctuation as base


The other table in this doc set uses italics for *Optional.*, but the style guide uses (*Optional)*
I'll leave it up to you.

rachel-mack · 2025-05-08T15:07:52Z

source/includes/collation.rst

+
+   * - ``alternate``
+     - | Optional. Specifies whether the driver considers whitespace and punctuation as base
+         characters for purposes of comparison.


I would add an **Accepted Values:** section

For all of the C# enum data types, I linked to the relevant API page, which documents the possible options. Similar for the string types linking to a page with the accepted options.

rachel-mack · 2025-05-08T15:08:49Z

source/includes/collation.rst

+     - ``Backwards``
+
+   * - ``caseFirst``
+     - | Optional. Specifies the sort order of case differences during tertiary level comparisons.


**Accepted Values:**

rachel-mack · 2025-05-08T15:16:49Z

source/includes/collation.rst

+     - | Optional. Specifies whether to include case comparison at strength level ``Primary`` or
+         ``Secondary``. 
+       |
+       | When this argument is ``true``:
+       |
+       | - If the strength is ``Primary``, the driver compares base
+           characters and case.
+       | - If the strength is ``Secondary``, the driver compares base
+           characters, diacritics, other secondary differences, and case.
+       |
+       | When this argument is ``false``, the driver doesn't include case comparison at
+         strength level ``Primary`` or ``Secondary``.


If there's a way to add a link to the strength parameter, I would do that here. I'm assuming this is why you were asking about nesting tables the other day, because that would make sense here.

Suggested change

- | Optional. Specifies whether to include case comparison at strength level ``Primary`` or

``Secondary``.

|

| When this argument is ``true``:

|

| - If the strength is ``Primary``, the driver compares base

characters and case.

| - If the strength is ``Secondary``, the driver compares base

characters, diacritics, other secondary differences, and case.

|

| When this argument is ``false``, the driver doesn't include case comparison at

strength level ``Primary`` or ``Secondary``.

- | Optional. Specifies whether to include case comparison.

|

| When this argument is ``true``, the behaviour depends on the value of the ``Strength`` property:

|

| - If the ``Strength`` property is ``Primary``, the driver compares base

characters and case.

| - If the ``Strength`` property is ``Secondary``, the driver compares base

characters, diacritics, other secondary differences, and case.

|

| When this argument is ``false``, the driver doesn't include case comparison.

I don't know of a way to link to another table row. I could move strength above caseLevel but I just moved them to parameter order and that would throw it off.

a note about the properties: they're read-only and set directly by these parameters, so i talk about the values of the parameters instead of the values of the properties.

rachel-mack · 2025-05-08T15:21:47Z

source/includes/collation.rst

+     - | Optional. Specifies which characters the driver considers ignorable when
+         ``Alternate`` is ``CollationAlternate.Shifted``.


add **Accepted Values:**

Suggested change

- | Optional. Specifies which characters the driver considers ignorable when

``Alternate`` is ``CollationAlternate.Shifted``.

- | Optional. Specifies which characters the driver considers ignorable when the

``Alternate`` property is ``CollationAlternate.Shifted``.

rachel-mack · 2025-05-08T15:22:29Z

source/includes/collation.rst

+     - ``MaxVariable``
+
+   * - ``normalization``
+     - | Optional. Specifies whether the driver normalizes text as needed.


Maybe add an example

how about a link to the ICU docs

rachel-mack · 2025-05-08T15:31:14Z

source/includes/collation.rst

+       | If this argument is ``true``, the driver compares numeric strings as numbers.
+         For example, "10" is greater than "2". If this argument is ``false`` or excluded,
+         the driver compares numeric strings as strings. For example, "10" is less than "2".


They're not being treated as strings so I would leave out the "s, you could make them 10 and 2 if you want to differentiate them:

Suggested change

| If this argument is ``true``, the driver compares numeric strings as numbers.

For example, "10" is greater than "2". If this argument is ``false`` or excluded,

the driver compares numeric strings as strings. For example, "10" is less than "2".

| If this argument is ``true``, the driver compares numeric strings as numbers.

For example, 10 is greater than 2.

|

| If this argument is ``false`` or excluded,

the driver compares numeric strings as strings. For example, "10" is less than "2".

they aren't being compared as strings, but they still are strings, so i think the quotes are useful. lmk if this change is clearer.

rachel-mack · 2025-05-08T15:32:36Z

source/includes/collation.rst

+For more information about collation, see the :manual:`Collation <reference/collation>`
+page in the {+mdb-server+} manual.


404

Suggested change

For more information about collation, see the :manual:`Collation <reference/collation>`

page in the {+mdb-server+} manual.

For more information about collation, see the :manual:`Collation </reference/collation>`

page in the {+mdb-server+} manual.

rachel-mack · 2025-05-08T15:40:52Z

source/includes/page-templates/update/update.rst

Is this still being used?

yeah, it's the page template for update-many and update-one

first draft

eef3229

mongoKart added 2 commits May 7, 2025 14:41

table fixes

02a59e2

fixes

169591e

rachel-mack requested changes May 8, 2025

View reviewed changes

rm review

ed9d6bc

mongoKart requested a review from rachel-mack May 8, 2025 21:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-49849 - Collation #628

DOCSP-49849 - Collation #628

mongoKart commented May 7, 2025 •

edited by github-actions bot

Loading

netlify bot commented May 7, 2025 •

edited

Loading

rachel-mack left a comment

rachel-mack May 8, 2025

rachel-mack May 8, 2025

mongoKart May 8, 2025

rachel-mack May 8, 2025

mongoKart May 8, 2025

rachel-mack May 8, 2025

mongoKart May 8, 2025 •

edited

Loading

rachel-mack May 8, 2025

rachel-mack May 8, 2025

mongoKart May 8, 2025

rachel-mack May 8, 2025

mongoKart May 8, 2025

rachel-mack May 8, 2025

rachel-mack May 8, 2025

mongoKart May 8, 2025

		- \| Optional. Specifies which characters the driver considers ignorable when
		``Alternate`` is ``CollationAlternate.Shifted``.

		For more information about collation, see the :manual:`Collation <reference/collation>`
		page in the {+mdb-server+} manual.

DOCSP-49849 - Collation #628

Are you sure you want to change the base?

DOCSP-49849 - Collation #628

Conversation

mongoKart commented May 7, 2025 • edited by github-actions bot Loading

Pull Request Info

Staging Links

Self-Review Checklist

netlify bot commented May 7, 2025 • edited Loading

✅ Deploy Preview for docs-csharp ready!

rachel-mack left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mongoKart May 8, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mongoKart commented May 7, 2025 •

edited by github-actions bot

Loading

netlify bot commented May 7, 2025 •

edited

Loading

mongoKart May 8, 2025 •

edited

Loading