-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Not all imported utility functions are described in the docs #3156
Copy link
Copy link
Closed
Labels
🔰 Good first issueA good task for those new to the libraryA good task for those new to the library📄 type: DocumentationUpdates, fixes and additions to documentationUpdates, fixes and additions to documentation🔧 type: MaintenanceRefactoring and maintenance of internalsRefactoring and maintenance of internals
Milestone
Description
scikit-image/skimage/__init__.py
Line 46 in 1151b51
| Utility Functions |
Proposed fix:
- Only import the utilities functions that we describe.
- Describe all utility functions that are actually imported.
To do 1. you would need to specify the functions we import in the line
from .util.dtypes import *To do 2. you would need to look at the file skimage.util.dtypes at the line
__all__ = [ ... ]and give a short description of the functions that are imported.
Python lesson: the list __all__ describes the functions that are imported when you use from XXXX import *
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
🔰 Good first issueA good task for those new to the libraryA good task for those new to the library📄 type: DocumentationUpdates, fixes and additions to documentationUpdates, fixes and additions to documentation🔧 type: MaintenanceRefactoring and maintenance of internalsRefactoring and maintenance of internals