Skip to content

GODRIVER-2010 Further clean up documentation examples #915

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.

Sign up for GitHub

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 7 commits into from
Apr 20, 2022
Merged

GODRIVER-2010 Further clean up documentation examples #915

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6131b87
Add README
Apr 19, 2022
97602ad
Use context.TODO in example code
Apr 19, 2022
8b7bfe1
Run WithTransactionExample and use ClusterURI
Apr 19, 2022
24372eb
Clean up examples testing
Apr 19, 2022
8a9e709
Add links to docs locations
Apr 19, 2022
89a05ee
Fix test failures
Apr 20, 2022
8bee3a9
Do not create collection for AggregationExamples
Apr 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions examples/documentation_examples/README
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Go Driver Documentation Examples
================================

examples.go contains numerous documentation examples that are rendered in various locations on www.mongodb.com/docs.
Each example is delineated with starting and ending comments (// Start/End Example #). All examples in examples.go
are valid Go driver code. Each example is run as part of our CI with examples_test.go, so all code is up-to-date and
accurate. We recommend using www.mongodb.com/docs to interact with these examples rather than viewing these files
directly.
Loading