Skip to content
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

[chore] Docstrings, part 2 #461

Merged
merged 9 commits into from
May 9, 2023
Merged

[chore] Docstrings, part 2 #461

merged 9 commits into from
May 9, 2023

Conversation

nwithan8
Copy link
Member

@nwithan8 nwithan8 commented May 9, 2023

Description

  • Docstrings for all models

Part of #459

Testing

  • N/A

Pull Request Type

Please select the option(s) that are relevant to this PR.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Improvement (fixing a typo, updating readme, renaming a variable name, etc)

@nwithan8 nwithan8 requested a review from a team as a code owner May 9, 2023 17:30
Copy link
Member

@Justintime50 Justintime50 left a comment

Choose a reason for hiding this comment

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

Note that we are now on the hook for every line of documentation which is now duplicated in this library. Anytime our docs change, we'll need to make updates to the duplicated docs in this library.

Makefile Show resolved Hide resolved
@nwithan8
Copy link
Member Author

nwithan8 commented May 9, 2023

Note that we are now on the hook for every line of documentation which is now duplicated in this library. Anytime our docs change, we'll need to make updates to the duplicated docs in this library.

Since we'd already have to add a new property in this library (and Java and Go) if the API schemas ever change, this was always true.

@nwithan8 nwithan8 merged commit 7e2bdaa into master May 9, 2023
13 checks passed
@nwithan8 nwithan8 deleted the docstrings_2 branch May 9, 2023 19:10
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.

None yet

3 participants