Skip to content

DOCSP-29802: explain text index field weights #685

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

Merged
merged 2 commits into from
May 16, 2023

Conversation

rustagir
Copy link
Collaborator

Pull Request Info

PR Reviewing Guidelines

JIRA - DOCSP-29802
Staging:

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?

Copy link
Collaborator

@caitlindavey caitlindavey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few suggestions one that is more strictly based on the style guide and a few others.

Comment on lines 54 to 56
When creating a compound text index, you can specify a weight option to
prioritize certain text fields in your index relative to the other
indexed fields. When you execute a text search, the field weights
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: Can you break up this sentence into smaller sentences for readability? Based on the style guide, this is on the cusp of the suggested word length.

Suggested change
When creating a compound text index, you can specify a weight option to
prioritize certain text fields in your index relative to the other
indexed fields. When you execute a text search, the field weights
When creating a compound text index, you can specify a weight option to
prioritize certain text fields in your index. Fields can be weighted relative to the other
indexed fields. When you execute a text search, the field weights

Comment on lines 67 to 68
See the MongoDB server manual to learn more about :manual:`text indexes
</core/index-text/>`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: Put the reason for the link first. Sharing the link to the style guide here.

Suggested change
See the MongoDB server manual to learn more about :manual:`text indexes
</core/index-text/>`.
To learn more about text indexes, see :manual:`text indexes </core/index-text/>` in the MongoDB server manual.

Comment on lines 220 to 221
The following is an example of a query that uses the text index created
in the previous code:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: Simplify

Suggested change
The following is an example of a query that uses the text index created
in the previous code:
The following query uses the text index created
in the previous code:

@rustagir rustagir merged commit 1bb2ae4 into mongodb:master May 16, 2023
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
(cherry picked from commit cc24b83)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
(cherry picked from commit cc24b83)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
(cherry picked from commit cc24b83)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
(cherry picked from commit cc24b83)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
(cherry picked from commit cc24b83)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
(cherry picked from commit cc24b83)
rustagir added a commit that referenced this pull request May 16, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
(cherry picked from commit cc24b83)
jordan-smith721 pushed a commit to jordan-smith721/docs-node that referenced this pull request Jul 24, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes

(cherry picked from commit 1bb2ae4)
(cherry picked from commit c0f3135)
(cherry picked from commit cc24b83)
mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023
* DOCSP-29802: explain text index field weights

* CD PR fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants