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: add documentation to sdk functions #2

Merged
merged 21 commits into from
Aug 17, 2022
Merged

docs: add documentation to sdk functions #2

merged 21 commits into from
Aug 17, 2022

Conversation

aspnxdd
Copy link
Contributor

@aspnxdd aspnxdd commented Aug 10, 2022

This PR adds jsdocs to the exported functions.

@aspnxdd aspnxdd requested a review from begonaalvarezd August 10, 2022 08:26
begonaalvarezd
begonaalvarezd requested changes Aug 17, 2022
View reviewed changes
Copy link
Member

@begonaalvarezd begonaalvarezd left a comment

Choose a reason for hiding this comment

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

Looking great, thanks for this 🙏🏼
added come minor comments to be consistent with the verbs and spacings

src/lib/cache/actions.ts Outdated Show resolved Hide resolved
src/lib/mint/mint.ts Outdated Show resolved Hide resolved
src/lib/mint/mint.ts Outdated Show resolved Hide resolved
src/lib/update.ts Outdated Show resolved Hide resolved
src/lib/upload/arweave.ts Outdated Show resolved Hide resolved
src/lib/upload/transactions.ts Outdated Show resolved Hide resolved
src/lib/upload/transactions.ts Outdated Show resolved Hide resolved
src/lib/upload/transactions.ts Outdated Show resolved Hide resolved
src/lib/upload/transactions.ts Outdated Show resolved Hide resolved
src/lib/upload/upload.ts Outdated Show resolved Hide resolved
@aspnxdd @begonaalvarezd
Update src/lib/cache/actions.ts
32d933e 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@begonaalvarezd begonaalvarezd mentioned this pull request Aug 17, 2022
Closed
aspnxdd and others added 9 commits August 17, 2022 11:58
@aspnxdd @begonaalvarezd
Update src/lib/mint/mint.ts
d20bdad 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/mint/mint.ts
689a940 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/update.ts
c7256be 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/arweave.ts
7755d67 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/transactions.ts
0b9befc 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/transactions.ts
4dfc820 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/transactions.ts
cb937ba 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/transactions.ts
0a49fb4 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/upload.ts
e1a470d 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd aspnxdd requested a review from begonaalvarezd August 17, 2022 09:59
aspnxdd and others added 6 commits August 17, 2022 13:15
@aspnxdd @begonaalvarezd
Update src/lib/upload/config.ts
a56d9cf 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/config.ts
a558f65 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/helpers.ts
074fd0d 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/helpers.ts
abba1de 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/helpers.ts
7ac8cdb 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@aspnxdd @begonaalvarezd
Update src/lib/upload/transactions.ts
53ff389 
Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>
@begonaalvarezd begonaalvarezd changed the title feat: docs functions docs: add documentation to sdk functions Aug 17, 2022
@begonaalvarezd begonaalvarezd merged commit b216a71 into main Aug 17, 2022
@begonaalvarezd begonaalvarezd deleted the feat/docs-functions branch August 17, 2022 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@begonaalvarezd begonaalvarezd begonaalvarezd 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.
2 participants
@aspnxdd @begonaalvarezd