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.

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

Add CoreDBSpec API documentation #418

Merged
merged 7 commits into from
Dec 13, 2023
Merged

Add CoreDBSpec API documentation #418

merged 7 commits into from
Dec 13, 2023

Conversation

nhudson
Copy link
Collaborator

@nhudson nhudson commented Dec 13, 2023

Add documentation annotations to most/all the CoreDBSpec objects in the CoreDB API.

  • To generate the docs locally you can check out this branch and run cargo doc --open. This will compile and open the docs in a local web browser.

fixes: TEM-2032.

@nhudson nhudson self-assigned this Dec 13, 2023
@nhudson nhudson marked this pull request as ready for review December 13, 2023 19:07
sjmiller609
sjmiller609 approved these changes Dec 13, 2023
View reviewed changes
Copy link
Contributor

@sjmiller609 sjmiller609 left a comment

Choose a reason for hiding this comment

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

I don't see any issues, and I read everything quickly. I would just do one change: make consistent any mention of postgres, postgresql PostgreSQL etc to "Postgres"

@nhudson nhudson merged commit a377faa into main Dec 13, 2023
15 checks passed
@nhudson nhudson deleted the nhudson/TEM-2032 branch December 13, 2023 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sjmiller609 sjmiller609 sjmiller609 approved these changes

@ianstanton ianstanton Awaiting requested review from ianstanton ianstanton is a code owner

@ChuckHend ChuckHend Awaiting requested review from ChuckHend ChuckHend is a code owner

Assignees

@nhudson nhudson

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nhudson @sjmiller609