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

docs: updates for return types for examples actix-web, tide, serenity, tower #892

Merged
merged 17 commits into from Oct 28, 2023
Merged

docs: updates for return types for examples actix-web, tide, serenity, tower #892

merged 17 commits into from Oct 28, 2023

Conversation

ethanholz
Copy link
Contributor

Description of change

Updated docs for better intellisense.

Related to #891

How Has This Been Tested (if applicable)?

n/a

@ethanholz ethanholz changed the title docs: updates for return types for examples actix-web, tide, serenity, next, tower docs: updates for return types for examples actix-web, tide, serenity, tower May 9, 2023
@ethanholz ethanholz marked this pull request as ready for review May 12, 2023 19:59
@jonaro00 jonaro00 added B-Shuttle Batch Submitted by a Shuttle Batch participant A-docs labels May 12, 2023
@iulianbarbu iulianbarbu added B-S A small task that is a good place to start for new contributors B-M A medium task that requires experience with the codebase and removed B-S A small task that is a good place to start for new contributors B-M A medium task that requires experience with the codebase labels May 16, 2023
iulianbarbu
iulianbarbu reviewed May 17, 2023
View reviewed changes
Copy link
Contributor

@iulianbarbu iulianbarbu left a comment

Choose a reason for hiding this comment

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

How have you decided between choosing what Shuttle services to document in terms of their return types? I think the rest can benefit too from such docs, but I am wondering if you thought about stopping this at a few and letting the rest for another PR, or you want to continue adding, for this PR to be complete. Let me know your thoughts.

Also, resources/persist can benefit too from a lib level docs.

resources/shared-db/src/lib.rs Outdated Show resolved Hide resolved
resources/shared-db/src/postgres.rs Outdated Show resolved Hide resolved
service/src/error.rs Outdated Show resolved Hide resolved
resources/secrets/src/lib.rs Outdated Show resolved Hide resolved
@ethanholz
Copy link
Contributor Author

These are just the ones in the example repo to start per the batch board. My partner has a separate PR for the other docs in the examples. The purpose of this PR is to help provide a better intellisense for new users and provide a framework for how we might implement these into other parts in the future.

ethanholz and others added 4 commits May 17, 2023 11:08
@ethanholz @iulianbarbu
Update resources/shared-db/src/lib.rs
b6b9036 
Co-authored-by: Iulian Barbu <14218860+iulianbarbu@users.noreply.github.com>
@ethanholz @iulianbarbu
Update resources/shared-db/src/postgres.rs
5ae68b9 
Co-authored-by: Iulian Barbu <14218860+iulianbarbu@users.noreply.github.com>
@ethanholz @iulianbarbu
Update service/src/error.rs
613b72a 
Co-authored-by: Iulian Barbu <14218860+iulianbarbu@users.noreply.github.com>
@ethanholz
style(shared-db): Updated for cargo fmt
83ff992
iulianbarbu
iulianbarbu approved these changes May 18, 2023
View reviewed changes
Copy link
Contributor

@iulianbarbu iulianbarbu left a comment

Choose a reason for hiding this comment

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

Thanks @ethanholz !

@iulianbarbu iulianbarbu mentioned this pull request May 18, 2023
Merged
oddgrd
oddgrd reviewed Jun 1, 2023
View reviewed changes
Copy link
Contributor

@oddgrd oddgrd left a comment

Choose a reason for hiding this comment

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

Thanks @ethanholz, this looks great! I just have a couple of small comments I think we should address and this is good to go. Apologies for the late review!

codegen/src/lib.rs Outdated Show resolved Hide resolved
codegen/src/lib.rs Outdated Show resolved Hide resolved
codegen/src/lib.rs Outdated Show resolved Hide resolved
@jonaro00 jonaro00 removed the A-docs label Aug 17, 2023
@jonaro00 jonaro00 removed B-S A small task that is a good place to start for new contributors B-Shuttle Batch Submitted by a Shuttle Batch participant labels Aug 17, 2023
@jonaro00 jonaro00 merged commit 3e63caa into shuttle-hq:main Oct 28, 2023
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oddgrd oddgrd oddgrd left review comments

@iulianbarbu iulianbarbu iulianbarbu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@ethanholz @iulianbarbu @oddgrd @jonaro00