Skip to content

Improve documentation for @semaphore/data package #768

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
Merged
merged 2 commits into from
May 7, 2024
Merged

Improve documentation for @semaphore/data package #768

merged 2 commits into from
May 7, 2024

Conversation

0xjei
Copy link
Contributor

@0xjei 0xjei commented May 6, 2024

Description

This PR aims at improving the documentation (code / README) for the @semaphore/data package.

Related Issue(s)

see #483

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have run yarn format and yarn lint without getting any errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@0xjei 0xjei requested review from cedoor and vplasencia May 6, 2024 15:03
@0xjei 0xjei mentioned this pull request Feb 28, 2024
Closed
10 tasks
cedoor
cedoor requested changes May 7, 2024
View reviewed changes
@0xjei 0xjei requested a review from cedoor May 7, 2024 13:10
@cedoor cedoor merged commit b9fa75c into main May 7, 2024
4 of 5 checks passed
@cedoor cedoor deleted the docs/data branch May 7, 2024 13:30
FaezehShakouri pushed a commit to FaezehShakouri/semaphore that referenced this pull request Feb 1, 2025
@0xjei
Improve documentation for @semaphore/data package (semaphore-protoc…
03f21d4 
…ol#768)

* docs(data): improve code comments and readme of the @semaphore/data package

* docs(data): update package.json description and small nit on README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cedoor cedoor cedoor approved these changes

@vplasencia vplasencia Awaiting requested review from vplasencia

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
@0xjei @cedoor