| Type | Description | PR | Issues | Author |
|---|
| Fix |
update `specification.yml` to show correct types of `Argument.location`, `Decoration.location` and `Module.location` | NiklasRosenstein/docspec#56 | NiklasRosenstein/docspec#52 | @NiklasRosenstein |
| Breaking change |
remove deprecated class `ReverseMap` | NiklasRosenstein/docspec#63 | | @NiklasRosenstein |
| Breaking change |
`Docstring` class no longer inherits from `str` and is no longer frozen | NiklasRosenstein/docspec#64 | NiklasRosenstein/docspec#49 | @NiklasRosenstein |
| Breaking change |
rename `Data` to `Variable` | NiklasRosenstein/docspec#68 | NiklasRosenstein/docspec#67 | @NiklasRosenstein |
| Hygiene |
move `VariableSemantic`, `FunctionSemantic` and `ClassSemantic` into global scope | | | @NiklasRosenstein |
| Improvement |
`filter_visit()` and `visit()` now expect a `MutableSequence` instead of `List` | | | @NiklasRosenstein |
| Hygiene |
remove `files` argument from `load_python_modules()` | | | @NiklasRosenstein |
| Improvement |
declare two overloads for `parse_python_module()` for reading from a filename or a file-like object | | | @NiklasRosenstein |
| Breaking change |
`Location.filename` is no longer optional as per the specification | | | @NiklasRosenstein |
| Breaking change |
harden requirements of spec by requiring a `location` even on `Decoration` and `Argument` objects, and the location is no longer optional. Rearrange the argument the Python classes such that the `location` argument comes first, always | NiklasRosenstein/docspec#70 | | @NiklasRosenstein |
| Breaking change |
remove `file` argument from `docspec-python` CLI | NiklasRosenstein/docspec#70 | | @NiklasRosenstein |
| Type | Description | PR | Issues | Author |
|---|
| Feature |
add `Data.modifiers`, `Data.semantic_hints`, `Class.modifiers`, `Class.semantic_hints` and `Function.semantic_hints` | | NiklasRosenstein/docspec#30 | @NiklasRosenstein |
| Improvement |
rename `Argument.Type` enumeration values to `UPPER_CASE` format according to latest specification (full backwards compatibility, including deserializing JSON payloads with the old argument type names) | | | @NiklasRosenstein |
| Feature |
add `Argument.location` and `Decoration.location` properties | | NiklasRosenstein/docspec#28 | @NiklasRosenstein |
| Feature |
add `Location.endlineno` property to spec | | NiklasRosenstein/docspec#32 | @NiklasRosenstein |
| Improvement |
add `Decoration.arglist`, document that `Decoration.args` is deprecated | | | @NiklasRosenstein |
| Type | Description | PR | Issues | Author |
|---|
| Feature |
add `ApiObject.parent` and `ApiObject.path` to deprecate `ReverseMap` class | | | @NiklasRosenstein |
| Feature |
add `ApiObject.sync_hierarchy()` method | | | @NiklasRosenstein |
| Feature |
introduce `HasMembers` base class for `Class` and `Module`, `Module.members` can now container other modules | | NiklasRosenstein/docspec#15 | @NiklasRosenstein |
| Improvement |
`get_member()` and `filter_visit()` have been updated to make use of the `HasMembers` base class instead of relying on `hasattr()`/`getattr()` | | | @NiklasRosenstein |
| Feature |
add `Indirection` class to keep track of imports and resolve names correctly. | | | @tristanlatr |
| Feature |
add `Docstring` class which represents the docstring, plus the location of the docstring | | | @NiklasRosenstein |