[TASK] Use auto-generated hierarchy in class diagram #518
Conversation
oliverklee
added this to the 9.0.0: Drop support for PHP < 7.2 and clean up things milestone
There was a problem hiding this comment.
Could you add a Composer script to run the tool, with the arguments you are using, including the tool as a dev dependency? Currently, the rest of us are somewhat in the dark as to how you are generating this automatically.
I'm guessing that at present you don't have a solution for automatically updating the readme between the "start of" and "end of" comments, though that could ultimately be achieved. Assuming not, something that outputs an .md (or whaterver) file to be inserted would suffice for now. If it outputs a fixed file (rather than to stdout), then that filename would probably need to be added to .gitignore.
This could be done as a separate PR first, using the command line that created the current content before this proposed change. Then updated in this PR to also generate the inheritance rules that are being moved to auto-generated with this PR.
Changes themselves seem fine, though I have a query about whether inheritence rules from in-built classes should be included. They weren't before (specifically: SourceException extends \Exception).
| Commentable <|.. Rule: realization | ||
| SourceException <|-- OutputException: inheritance | ||
| UnexpectedTokenException <|-- UnexpectedEOFException: inheritance | ||
| Exception <|-- SourceException: inheritance |
There was a problem hiding this comment.
Should inheritance from in-built classes be included?
There was a problem hiding this comment.
As far as I know, there is no option to configure this behavior. So if we want to automate this, I propose we stick to what the tool generates.
JakeQZ
changed the title
|
I have create #521 for the Composer script and would suggest moving this change here first to get it out of the way. |
…gram Now the only part of the class diagram which we need to maintain manually are the associations between classes.
oliverklee
force-pushed
the
docs/class-diagram-inheritence
branch
from
cf13c18 to
bd81cd1
Compare
Yes - I only rebased on top of the current |
Now the only part of the class diagram which we need to maintain manually are the associations between classes.