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

README does not contain a project description #7

Closed
FlorianLudwig opened this issue Sep 24, 2022 · 1 comment
Closed

README does not contain a project description #7

FlorianLudwig opened this issue Sep 24, 2022 · 1 comment

Comments

@FlorianLudwig
Copy link

FlorianLudwig commented Sep 24, 2022

Intentionally left blank

@jaraco
Copy link
Owner

jaraco commented Sep 27, 2022

The package does contain a description:

description = Utility functions for Python class constructs

And the readme should link to the documentation, which provides API docs and examples of what each function does. Between the self-documenting code and the project description, I'm struggling to come up with more detail that would be meaningful.

Oh! The readme doesn't link to the docs. That's a mistake. I'll make sure the badge/link is present.

If you think there's something more that should be provided by the README, feel free to write it or ask the questions that you wish the README would answer.

@jaraco jaraco closed this as completed in 1a14084 Sep 27, 2022
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

2 participants