Skip to content
This repository has been archived by the owner on Nov 5, 2023. It is now read-only.

Doc: In code documentation #25

Closed
1 of 3 tasks
CosmicHorrorDev opened this issue Apr 28, 2020 · 1 comment
Closed
1 of 3 tasks

Doc: In code documentation #25

CosmicHorrorDev opened this issue Apr 28, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@CosmicHorrorDev
Copy link
Owner

Documentation

  • There is a mistake in the documentation
  • Something is missing or needs clarifying
  • Other:

Description

So there's plenty of good documentation in the repo, but basically no doc comments in the library itself which can be painful since doc comments are what normally pop up from things like jedi. It will involve duplicating some of the documentation, but it would definitely be helpful to include documentation within the library itself.
@CosmicHorrorDev CosmicHorrorDev added the documentation Improvements or additions to documentation label Apr 28, 2020
@CosmicHorrorDev
Copy link
Owner Author

Added in a61d258.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CosmicHorrorDev