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

Added fetching of cog modules and cog classes #235

Draft
wants to merge 40 commits into
base: master
Choose a base branch
from

Conversation

MoistBiscuits
Copy link
Contributor

@MoistBiscuits MoistBiscuits commented Aug 2, 2021

Summary

Automatic documentation.json generation for #203
Adds GenerateDoc.py which searches the cogs folder to create documentation.json automatically

Checklist

  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

  • Have you tested the changes? (pytest & dpytest)
  • Have you followed PEP-8 for naming and styling?
  • Has your code been properly documented with RestructuredText docstrings?
  • Have you added your changes to CHANGELOG.md under the [Unreleased] heading?
  • If your code added new bot commands, have you updated documentation.json?

  • All of this code is your own, or follows the author repo's licence.

@MoistBiscuits MoistBiscuits self-assigned this Aug 2, 2021
@codecov
Copy link

codecov bot commented Aug 2, 2021

Codecov Report

Merging #235 (ac6ea00) into master (d666525) will increase coverage by 0.30%.
The diff coverage is 96.42%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #235      +/-   ##
==========================================
+ Coverage   82.28%   82.58%   +0.30%     
==========================================
  Files          26       28       +2     
  Lines        6457     6597     +140     
==========================================
+ Hits         5313     5448     +135     
- Misses       1144     1149       +5     
Flag Coverage Δ
unittests 82.58% <96.42%> (+0.30%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
GenerateDoc.py 94.89% <94.89%> (ø)
KoalaBot.py 81.91% <100.00%> (+0.39%) ⬆️
tests/test_GenerateDoc.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d666525...ac6ea00. Read the comment docs.

@MoistBiscuits
Copy link
Contributor Author

Really sorry about the commit spam, was having a lot of issues with github actions, should hopefully be working by now

@MoistBiscuits
Copy link
Contributor Author

GeneratDoc.py is finished and the github actions should be setup to update Documentation.json whenever a commit is made to a pull request, but I'm open to different implementations of when to trigger document generation

@MoistBiscuits MoistBiscuits marked this pull request as ready for review August 4, 2021 14:24
@Kaspiaan Kaspiaan assigned Kaspiaan and unassigned MoistBiscuits and cwsbowe Oct 18, 2021
@VirajShah18 VirajShah18 marked this pull request as draft November 9, 2021 00:41
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.

Automatic documentation.json generation
4 participants