-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature/add properties v3 #171
base: master
Are you sure you want to change the base?
Feature/add properties v3 #171
Conversation
-> Add new constructor in Field -> Delete class FieldSchema
Let me know when you want a review. I'll need a detailed description of your aims though. Oh and you need to pass CI too (see below). |
Release note
|
Looks interesting. Have you checked the appearance of the other diagrams in demos? What's good for you might be a whole lot of mess for others. Probably boils down to configuration options which you have a TODO for. Default will probably be to leave that stuff out. |
- Extend properties on other case - Add example
An option should be added to display the notes (yellow tag) (see TODO) If we compare with before, links are lost |
I think I'm done. |
Hi Dimitri This is your summary:
Each of those contributions should be a separate PR but the best idea is to discuss what you want to do first so you don't put too much effort in to something that doesn't get accepted. The output of this project is a UML Diagram that communicates the essence of the API, not the details. I'm not happy with the addition of string maxLength and notes because it seems like needless clutter. For example with the notes, in general the times that a description adds more than just the existing name of the field is when the description is long and detailed. In that specific case I also don't want that appearing as extra clutter. Here's a quick example of a long description (my apis have lots of long descriptions) that I definitely would not want in a diagram!
The {O} vs {R} usage is a style thing. Where have you seen {R} usage? Got links? I find {O} usage less noisy than {R} usage in general and that is apparent in the bookstore diagram above.
I need more info on this one.
I need more info on this effects of this one So I'm not open to adding Note, size, and {R} instead of {O}. I don't see them as adding value but you can try and convince me! The other two issues need more explanation and should be opened as separate PRs please. I see your PR does not pass CI. This mean that running Another tip for PR contributions is to do all your work in your fork of the repo and only open a PR on the original repo when your PR is ready for review. That way I won't be drawn by notifications to inspect your changes only to see they are not ready for review. |
No description provided.