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.

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

docs: various updates (rebase) #90

Merged
merged 5 commits into from
Aug 23, 2024
Merged

docs: various updates (rebase) #90

merged 5 commits into from
Aug 23, 2024

Conversation

uniqueg
Copy link
Member

@uniqueg uniqueg commented Aug 23, 2024

  • docs: add usage examples
  • docs: update ZARP citation & add download button
  • docs(footer): replace Twitter with X icon
  • docs: fix typos & add clarifications
  • docs: fix build warning

Type of change

  • Documentation update

Checklist

  • I have performed a self-review of my own code
  • My code follows the existing coding style, lints and generates no new
    warnings
  • I have added type annotations to all function/method signatures, and I
    have added type annotations for any local variables that are non-trivial,
    potentially ambiguous or might otherwise benefit from explicit typing.
  • I have commented my code in hard-to-understand areas
  • I have added Google-style
    docstrings

    to all new modules, classes,
    methods/functions or updated previously existing ones
  • 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 and I have not
    reduced the code coverage relative to the previous state
  • I have updated any sections of the app's documentation that are affected
    by the proposed changes

Copy link

codecov bot commented Aug 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4f86176) to head (df7ea9f).
Report is 5 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff            @@
##               dev       #90   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           24        24           
  Lines         1264      1263    -1     
=========================================
- Hits          1264      1263    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@uniqueg uniqueg changed the title Docs docs: various updates (rebase) Aug 23, 2024
@uniqueg uniqueg merged commit 9360348 into dev Aug 23, 2024
12 checks passed
@uniqueg uniqueg deleted the docs branch August 23, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant