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

✏️Adding Docstrings #217

Draft
wants to merge 9 commits into
base: rewrite
Choose a base branch
from
Draft

Conversation

Jerry-py
Copy link
Contributor

@Jerry-py Jerry-py commented Mar 17, 2023

Description

Basically just docstrings

Checklist

  • - All code changes have been tested, if any
  • - The documentation has been updated accordingly for any code changes
  • - This PR fixes an already existing issue
  • - This PR adds a new feature (new functions, methods, classes, parameters, etc.)
  • - This PR fixes a bug
  • - This PR is a breaking change (removes/renames functions, parameters etc.)
  • - This PR is NOT a code change (changes Documentation files, README.md, CONTRIBUTING.md etc.)

Additional context

@codecov
Copy link

codecov bot commented Mar 17, 2023

Codecov Report

Patch coverage: 38.16% and project coverage change: -6.58 ⚠️

Comparison is base (1cd88be) 64.21% compared to head (77b83f6) 57.63%.

❗ Current head 77b83f6 differs from pull request most recent head ea54bd0. Consider uploading reports for the commit ea54bd0 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##           rewrite     #217      +/-   ##
===========================================
- Coverage    64.21%   57.63%   -6.58%     
===========================================
  Files           19       25       +6     
  Lines         1249     1669     +420     
===========================================
+ Hits           802      962     +160     
- Misses         447      707     +260     
Impacted Files Coverage Δ
EpikCord/application.py 0.00% <0.00%> (ø)
EpikCord/client/commands.py 0.00% <0.00%> (ø)
EpikCord/client/http.py 33.91% <0.00%> (-0.30%) ⬇️
EpikCord/client/websocket.py 32.73% <0.00%> (-0.76%) ⬇️
EpikCord/exceptions.py 77.55% <ø> (+4.08%) ⬆️
EpikCord/guild.py 0.00% <0.00%> (ø)
EpikCord/interaction.py 0.00% <0.00%> (ø)
EpikCord/user.py 0.00% <0.00%> (ø)
EpikCord/utils/__init__.py 100.00% <ø> (ø)
EpikCord/file.py 62.06% <26.66%> (-32.05%) ⬇️
... and 7 more

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Jerry-py
Copy link
Contributor Author

This is only a draft I'm not finished with it

@Jerry-py Jerry-py marked this pull request as draft March 20, 2023 23:07
@Jerry-py
Copy link
Contributor Author

Jerry-py commented Mar 20, 2023

@TheUntraceable There are missing sentences like :class:`` or ...

Those I don't what to write for them. In ./Epikcord/exceptions.py there are a lot of incomplete sentences. Go ahead and fix my mistakes

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.

2 participants