Skip to content

GODRIVER-3327 Move option docs from struct fields to setter methods #1849

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

Jump to bottom
Merged
merged 32 commits into from
Oct 14, 2024
Merged

GODRIVER-3327 Move option docs from struct fields to setter methods #1849

merged 32 commits into from
Oct 14, 2024

Conversation

joyjwang
Copy link
Contributor

@joyjwang joyjwang commented Oct 7, 2024 •
edited
Loading

GODRIVER-3327

Summary

  • moved all documentation from structs to setter methods
  • left a simple note in structs directing users to view setter methods for documentation (another option is referencing the relevant setter method for each struct field, which may be clearer for users?)

Background & Motivation

@mongodb-drivers-pr-bot mongodb-drivers-pr-bot bot added the review-priority-low Low Priority PR for Review: within 3 business days label Oct 7, 2024
@mongodb-drivers-pr-bot mongodb-drivers-pr-bot
Copy link
Contributor

API Change Report

No changes found!

joyjwang added 27 commits October 7, 2024 11:37
@joyjwang
edit
34df9cb
@joyjwang
autoencryptionoptions
f4a92b8
@joyjwang
bulkwriteoptions
f9c5b8f
@joyjwang
changestreamoptions
2192617
@joyjwang
clientencryptionoptions
29508a4
@joyjwang
collectionoptions
5e27d30
@joyjwang
countoptions
84bd00b
@joyjwang
createcollectionoptions, defaultindexoptions, timeseriesoptions, crea…
759c1c8 
…teviewoptions
@joyjwang
datakeyoptions
784be7d
@joyjwang
dboptions
541b18c
@joyjwang
deleteoneoptions and deletemanyoptions
4109cb4
@joyjwang
distinctoptions
8f1197c
@joyjwang
dropcollectionoptions
30bbd55
@joyjwang
encryptoptions
4c43906
@joyjwang
estimateddocumentcountoptions
a922713
@joyjwang
findoptions, findoneoptions, findoneanddeleteoptions, findoneandrepla…
afcbddc 
…ceoptions, findoneandupdateoptions
@joyjwang
bucketoptions, gridfsuploadoptions, gridfsnameoptions, gridfsfindoptions
793dba3
@joyjwang
createindexesoptions, listindexesoptions, indexoptions
b26f29e
@joyjwang
insertoneoptions, insertmanyoptions
c75ca46
@joyjwang
listcollectionoptions, listdatabasesoptions
2955642
@joyjwang
loggeroptions
7194b1e
@joyjwang
rangeoptions
b38f813
@joyjwang
replaceoptions
962f8c6
@joyjwang
rewrapmanydatakeyoptions
f98903b
@joyjwang
runcmdoptions
c1a665c
@joyjwang
serverapioptions
b9eaf31
@joyjwang
sessionoptions
16adabe
@joyjwang joyjwang marked this pull request as ready for review October 9, 2024 19:03
matthewdale
matthewdale approved these changes Oct 11, 2024
View reviewed changes
Copy link
Collaborator

@matthewdale matthewdale left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

@joyjwang joyjwang merged commit 2cbff02 into mongodb:master Oct 14, 2024
31 of 33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@matthewdale matthewdale matthewdale approved these changes

@prestonvasquez prestonvasquez prestonvasquez approved these changes

Assignees

No one assigned

Labels

review-priority-low Low Priority PR for Review: within 3 business days

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@joyjwang @matthewdale @prestonvasquez