Skip to content

Commit 5e405cf

Browse files
authored
docs(readme): complex compound types are properly handled (#38)
1 parent db134ca commit 5e405cf

File tree

1 file changed

+1
-4
lines changed

1 file changed

+1
-4
lines changed

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,7 @@ poetry run pytest -v --cov=py2puml --cov-branch --cov-report term-missing --cov-
197197

198198
# Changelog
199199

200+
* `0.7.1`: removed obsolete part of documentation: deeply compound types are now well handled (by version `0.7.0`)
200201
* `0.7.0`: improved the generated PlantUML documentation (added the namespace structure of the code base, homogenized type between inspection and parsing), improved relationships management (handle forward references, deduplicate relationships)
201202
* `0.6.1`: handle class names with digits
202203
* `0.6.0`: handle abstract classes
@@ -233,10 +234,6 @@ Follow the [contributing guide](CONTRIBUTING.md).
233234

234235
> The Python runtime does not enforce function and variable type annotations. They can be used by third party tools such as type checkers, IDEs, linters, etc.
235236
236-
* complex type hints with more than one level of genericity are not properly handled for the moment: `List[MyClass]` or `Dict[str, MyClass]` are handled properly, `Dict[str, List[MyClass]]` is not.
237-
If your domain classes (also called business objects or DTOs) have attributes with complex type hints, it may be a code smell indicating that you should write a class which would better represent the business logic.
238-
But I may improve this part of the library as well 😀
239-
240237
* regarding the detection of instance attributes with **AST parsing**:
241238
* only constructors are visited, attributes assigned in other functions won't be documented
242239
* attribute types are inferred from type annotations:

0 commit comments

Comments
 (0)