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

Add Documenation about classes #388

Open
Kaligule opened this issue Jul 3, 2020 · 0 comments
Open

Add Documenation about classes #388

Kaligule opened this issue Jul 3, 2020 · 0 comments

Comments

@Kaligule
Copy link

Kaligule commented Jul 3, 2020

Going through the code I notice that the classnames were choosen to contain meaning, but this is not documented and they are not as selfexplanatory as the author might have thought. Examples are:

  • Bot (What is a bot?)
  • Update (Is this an update of a single package or of all packages in the repo? What is the difference between InitialUpdate, SequentialUpdate, ScheduledUpdate and BundledUpdate?)
  • Config (What is configured? A Bot? A PR? Everything?)
  • RequirementsBundle (I have no idea what this might be.)

It would be cool if these classes would have docstrings that describe their scope. This would greatly improove the experience for new potential contributors.

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

No branches or pull requests

1 participant