-
Notifications
You must be signed in to change notification settings - Fork 61
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
refactor INTF #85
refactor INTF #85
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks good to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice pull request. Thanks!
I didn't really like the includes in the types as well. I just added them for the sake of reuse, but it is fine for me if we duplicate code here. :)
Note that the schema field is removed from the header! ...
I don't think we want to persist a URL inside the files, it might change in the future.
We have to specify in which content version the content was stored. How would you add this identification? For me the $schema
made sense to use it also as content version identification.
But I think, you are right we don't need it necessarily in the ABAP type. This could be also passed by the corresponding implementations to distinguish the content version.
There are some issues with ABAP Doc comments. I made suggestions how to fix them.
for versioning, I suggest deferring to #53 for possible solutions suggestions committed |
Co-authored-by: Michael Schneider <[email protected]>
Co-authored-by: Michael Schneider <[email protected]>
Co-authored-by: abaplint[bot] <24845621+abaplint[bot]@users.noreply.github.com>
Co-authored-by: Michael Schneider <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks.
We can follow-up versioning separately.
With 16+ years in ABAP I'm a newbie, and I have trouble reading the source code, this refactors INTF and removes all INCLUDE STRUCTURE, hopefully making it easier for humans to read.
It does however, sacrifice some reuse and introduces a bit of duplication, but IMHO its okay
Note that the
schema
field is removed from the header!$schema
is not a json schema property, its a thing implemented in some editors like vscode. Editors have mechanisms to identify the correct schema for a file, I don't think we want to persist a URL inside the files, it might change in the future.single definitions refactored to abapdoc + ABAP, instead of ABAP + abapdoc + ABAP, to
from
which also follows https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#do-not-chain-up-front-declarations