Skip to content

Feature/api documentation #31

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
Open
gannonsmith wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Feature/api documentation #31

gannonsmith wants to merge 3 commits into from

Conversation

@gannonsmith
Copy link
Collaborator

@gannonsmith gannonsmith commented Jul 13, 2023

No description provided.

@gannonsmith gannonsmith requested review from erics03 and jbis9051 July 13, 2023 03:04
@jbis9051
Copy link
Owner

jbis9051 commented Jul 14, 2023

We don't need the request/response stuff in the documentation as it's in the types right below the comments. Furthermore, we do need the identity documentation and more texty stuff. Also use /// instead of /* https://doc.rust-lang.org/rust-by-example/meta/doc.html

jbis9051
jbis9051 requested changes Jul 14, 2023
View reviewed changes
Copy link
Owner

@jbis9051 jbis9051 left a comment

Choose a reason for hiding this comment

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

See above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jbis9051 jbis9051 jbis9051 requested changes

@erics03 erics03 Awaiting requested review from erics03

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@gannonsmith @jbis9051