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 doc comments for credentials #355

Merged

nitro-neal merged 16 commits into main from kendall/doc-comments

Sep 16, 2024

Contributor

KendallWeihe commented Sep 13, 2024

Add all doc comments to APID
Add doc comments to rust for VC and Verifiable Presentation
Add examples, and add to test suite
Add just docs Justfile recipe
Add same set of doc comments to kotlin code

KendallWeihe added 4 commits

September 12, 2024 14:04


          Add doc comments to APID

e02a802


          Add rust doc comments for vc

10406e3


          Add doc comments for vp

3ee519e


          Add doc comments to relevant kt code

4cfc4f4

KendallWeihe requested review from nitro-neal, shamilovtim, diehuxx, frankhinek and leordev as code owners

September 13, 2024 14:19

nitro-neal reviewed

View reviewed changes

bound/kt/src/main/kotlin/web5/sdk/vc/StatusListCredential.kt Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

bound/kt/src/main/kotlin/web5/sdk/vc/StatusListCredential.kt Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

bound/kt/src/main/kotlin/web5/sdk/vc/VerifiableCredential.kt Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

bound/kt/src/main/kotlin/web5/sdk/vc/VerifiableCredential.kt Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

crates/web5/src/credentials/status_list_credential.rs Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

crates/web5/src/credentials/status_list_credential.rs Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

crates/web5/src/credentials/status_list_credential.rs Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

crates/web5/src/credentials/verifiable_credential_1_1.rs Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

crates/web5/src/credentials/verifiable_credential_1_1.rs Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

crates/web5/src/credentials/verifiable_credential_1_1.rs Outdated Show resolved Hide resolved

nitro-neal reviewed

View reviewed changes

crates/web5/src/credentials/verifiable_presentation_1_1.rs Outdated Show resolved Hide resolved

nitro-neal approved these changes

View reviewed changes

Contributor

nitro-neal left a comment •

edited

Loading

Great stuff, lots of work here.

I think it overall it could be a bit too verbose,

I think we can

remove imports in docs
remove jwts in docs
remove duplicate definitions, like vc context field is defined in vc data model and vc create options, (and other places?) can just remove from the vc create options field comment or just say its the optional vc context override, dont have to redefine the meaning of what the context is

nitro-neal added 9 commits

September 16, 2024 11:48


          Update bound/kt/src/main/kotlin/web5/sdk/vc/StatusListCredential.kt

9b7b867


          Update bound/kt/src/main/kotlin/web5/sdk/vc/StatusListCredential.kt

5a1f9f5


          Update bound/kt/src/main/kotlin/web5/sdk/vc/VerifiableCredential.kt

99b6c37


          Update bound/kt/src/main/kotlin/web5/sdk/vc/VerifiableCredential.kt

b67c883


          Update crates/web5/src/credentials/status_list_credential.rs

41c380d


          Update crates/web5/src/credentials/status_list_credential.rs

f8fc439


          Update crates/web5/src/credentials/status_list_credential.rs

99aba53


          Update crates/web5/src/credentials/verifiable_credential_1_1.rs

f3e1c75


          Update crates/web5/src/credentials/verifiable_credential_1_1.rs

33cd392

nitro-neal and others added 3 commits

September 16, 2024 11:49


          Update crates/web5/src/credentials/verifiable_credential_1_1.rs

cf614dd


          Update crates/web5/src/credentials/verifiable_presentation_1_1.rs

584aa61


          add ignore

3ad0e3b

nitro-neal merged commit a565623 into main

22 checks passed

nitro-neal deleted the kendall/doc-comments branch

September 16, 2024 19:12

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

Reviewers

nitro-neal nitro-neal approved these changes

shamilovtim Awaiting requested review from shamilovtim

diehuxx Awaiting requested review from diehuxx

frankhinek Awaiting requested review from frankhinek

leordev Awaiting requested review from leordev

Labels

None yet