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

Add an error code for missing docstring in a package #106

Closed
Nurdok opened this issue Feb 17, 2015 · 5 comments
Closed

Add an error code for missing docstring in a package #106

Nurdok opened this issue Feb 17, 2015 · 5 comments
Assignees

Comments

@Nurdok
Copy link
Member

Nurdok commented Feb 17, 2015

Missing docstring in __init__.py files should be a different error than in a regular module.

@sigmavirus24
Copy link
Member

Is it so this can be ignored more easily?

@Nurdok
Copy link
Member Author

Nurdok commented Feb 17, 2015

Yes. I find that docstring in (mostly empty) __init__.py files are usually ignored, as opposed to regular modules.

@jayvdb
Copy link
Member

jayvdb commented Feb 18, 2015

If this is done, I suggest it should only a different code if the init.py is effectively empty, and preferably without imports. But in that case, why not just exclude the init.py entirely?

@sigmavirus24
Copy link
Member

@jayvdb No one is arguing that this should be off by default but that it should just be an entirely separate error.

@jayvdb
Copy link
Member

jayvdb commented Feb 18, 2015

I didnt mention 'default'.

I am suggesting it isnt a separate problem deserving of a separate error code unless the contents of the file are somehow different. a/foo/init.py is not substantially different from a/foo.py unless a/foo/bar.py exists.

@Nurdok Nurdok self-assigned this Aug 1, 2015
@Nurdok Nurdok modified the milestone: Next release Aug 2, 2015
@Nurdok Nurdok closed this as completed Sep 12, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants