Update rst spec links to markdown #1741
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
Updates documentation links throughout the codebase to point to markdown files instead of RST files in the MongoDB specifications repository. This ensures that anchor links work correctly and maintains consistency with the current documentation format.
- Changed file extensions from
.rstto.mdin specification URLs - Updated anchor links to use markdown format instead of RST format
- Maintained links that reference specific commits unchanged
Reviewed Changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tools/connect.php | Updated SRV records specification link to markdown |
| tests/UnifiedSpecTests/UnifiedTestRunner.php | Updated unified test format specification links to markdown |
| tests/UnifiedSpecTests/UnifiedTestCase.php | Updated unified test format specification link to markdown |
| tests/UnifiedSpecTests/UnifiedSpecTest.php | Updated unified test format specification link to markdown |
| tests/UnifiedSpecTests/EventObserver.php | Updated command monitoring specification links to markdown |
| tests/SpecTests/TransactionsSpecTest.php | Updated transactions specification link to markdown |
| tests/SpecTests/SearchIndexSpecTest.php | Updated search index management specification links to markdown |
| tests/SpecTests/ResultExpectation.php | Updated transactions test format specification link to markdown |
| tests/SpecTests/FunctionalTestCase.php | Updated transactions specification link to markdown |
| tests/SpecTests/ClientSideEncryptionSpecTest.php | Updated client-side encryption specification links to markdown |
| src/functions.php | Updated client-side encryption and CRUD specification links to markdown |
| src/Operation/Watch.php | Updated change streams specification links to markdown |
| src/Operation/DropEncryptedCollection.php | Updated client-side encryption specification link to markdown |
| src/Operation/CreateEncryptedCollection.php | Updated client-side encryption specification links to markdown |
| src/Operation/CountDocuments.php | Updated CRUD specification link to markdown |
| src/Model/SearchIndexInput.php | Updated index management specification link to markdown |
| src/Model/IndexInput.php | Updated enumerate indexes specification link to markdown |
| src/Model/IndexInfo.php | Updated enumerate indexes specification links to markdown |
| src/Model/CollectionInfo.php | Updated enumerate collections specification link to markdown |
| src/Model/ChangeStreamIterator.php | Updated change streams specification link to markdown |
| src/Database.php | Updated client-side encryption specification link to markdown |
| src/ChangeStream.php | Updated change streams specification link to markdown |
| benchmark/src/DriverBench/MultiDocBench.php | Updated benchmarking specification link to markdown |
| CONTRIBUTING.md | Updated specification links in environment variable documentation to markdown |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v2.x #1741 +/- ##
=========================================
Coverage 87.55% 87.55%
Complexity 3184 3184
=========================================
Files 424 424
Lines 6340 6340
=========================================
Hits 5551 5551
Misses 789 789
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed that many spec links were still pointing to the RST files, which breaks anchors. This PR changes all links to markdown, except for the ones that reference a specific commit (as the markdown file probably doesn't exist there). We can consider changing those to point to the latest version separately.