Files Analyzed: 14
Total Functions: 236
Total Classes: 63
Functions with Docstrings: 59/236 (25.0%)
Classes with Docstrings: 56/63
Missing Docstrings: 184
Stale/Invalid Docstrings: 65
| File | Missing |
|---|---|
| samples/marshmallow/src/marshmallow/class_registry.py | 2 |
| samples/marshmallow/src/marshmallow/constants.py | 6 |
| samples/marshmallow/src/marshmallow/decorators.py | 1 |
| samples/marshmallow/src/marshmallow/error_store.py | 4 |
| samples/marshmallow/src/marshmallow/exceptions.py | 3 |
| samples/marshmallow/src/marshmallow/experimental/context.py | 3 |
| samples/marshmallow/src/marshmallow/fields.py | 85 |
| samples/marshmallow/src/marshmallow/orderedset.py | 11 |
| samples/marshmallow/src/marshmallow/schema.py | 11 |
| samples/marshmallow/src/marshmallow/types.py | 5 |
| samples/marshmallow/src/marshmallow/utils.py | 7 |
| samples/marshmallow/src/marshmallow/validate.py | 46 |
See missing docstrings below.
See missing docstrings below.
| Module | Count | Items |
|---|---|---|
| fields.py | 85 | samples/marshmallow/src/marshmallow/fields.py: class _BaseFieldKwargs; samples/marshmallow/src/marshmallow/fields.py: Field.__init__; samples/marshmallow/src/marshmallow/fields.py: Field.__repr__... |
| validate.py | 46 | samples/marshmallow/src/marshmallow/validate.py: Validator.__repr__; samples/marshmallow/src/marshmallow/validate.py: Validator.__call__; samples/marshmallow/src/marshmallow/validate.py: And.__init__... |
| orderedset.py | 11 | samples/marshmallow/src/marshmallow/orderedset.py: class OrderedSet; samples/marshmallow/src/marshmallow/orderedset.py: OrderedSet.__init__; samples/marshmallow/src/marshmallow/orderedset.py: OrderedSet.__len__... |
| schema.py | 11 | samples/marshmallow/src/marshmallow/schema.py: SchemaMeta.__new__; samples/marshmallow/src/marshmallow/schema.py: SchemaMeta.__init__; samples/marshmallow/src/marshmallow/schema.py: SchemaOpts.__init__... |
| utils.py | 7 | samples/marshmallow/src/marshmallow/utils.py: is_aware; samples/marshmallow/src/marshmallow/utils.py: from_timestamp; samples/marshmallow/src/marshmallow/utils.py: from_timestamp_ms... |
| constants.py | 6 | samples/marshmallow/src/marshmallow/constants.py: class _Missing; samples/marshmallow/src/marshmallow/constants.py: _Missing.__bool__; samples/marshmallow/src/marshmallow/constants.py: _Missing.__copy__... |
| types.py | 5 | samples/marshmallow/src/marshmallow/types.py: class SchemaValidator; samples/marshmallow/src/marshmallow/types.py: SchemaValidator.__call__; samples/marshmallow/src/marshmallow/types.py: class RenderModule... |
| error_store.py | 4 | samples/marshmallow/src/marshmallow/error_store.py: copy_containers; samples/marshmallow/src/marshmallow/error_store.py: class ErrorStore; samples/marshmallow/src/marshmallow/error_store.py: ErrorStore.__init__... |
| exceptions.py | 3 | samples/marshmallow/src/marshmallow/exceptions.py: ValidationError.__init__; samples/marshmallow/src/marshmallow/exceptions.py: ValidationError.normalized_messages; samples/marshmallow/src/marshmallow/exceptions.py: ValidationError.messages_dict |
| context.py | 3 | samples/marshmallow/src/marshmallow/experimental/context.py: Context.__init__; samples/marshmallow/src/marshmallow/experimental/context.py: Context.__enter__; samples/marshmallow/src/marshmallow/experimental/context.py: Context.__exit__ |
Docstrings that don't match function signatures: