-
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
[SKTD] New object type: Knowledge transfer documents #270
base: main
Are you sure you want to change the base?
Conversation
Thanks @uenal-akkaya. I suggest to convert this PR to a draft. Is this fine for you? |
@schneidermic0 You can convert this to a draft. Thanks. |
Fix abaplint issue Co-authored-by: abaplint[bot] <24845621+abaplint[bot]@users.noreply.github.com>
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 @uenal-akkaya. I would like to request some changes. See my comments/suggestions.
@uenal-akkaya Thanks for the update. The editor configuration shows that there are some whitespaces in empty lines. Are they really necessary. If not, can we remove them? |
Not sure which the editor configuration is. Can you name them? |
The repository is checked by an editorconfig file. See https://github.com/SAP/abap-file-formats/blob/34ad66189f7e39bb5aa10cb125f8dd90233b4e43/.editorconfig. The config checks whether there are any unnecessary whitespace in the code, because this might lead to unnecessary diffs if you compare it to new changes. |
|
||
File | Cardinality | Definition | Schema | Example | ||
:--- | :--- | :--- | :--- | :--- | ||
`<name>.sktd.json` | 1 | [`zif_aff_sktd_v1.intf.abap`](./type/zif_aff_sktd_v1.intf.abap) | [`sktd-v1.json`](./sktd-v1.json) | [`z_aff_example_sktd.sktd.json`](./examples/z_aff_example_sktd.sktd.en.json) |
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.
Wrong link to the JSON example file.
`<name>.sktd.json` | 1 | [`zif_aff_sktd_v1.intf.abap`](./type/zif_aff_sktd_v1.intf.abap) | [`sktd-v1.json`](./sktd-v1.json) | [`z_aff_example_sktd.sktd.json`](./examples/z_aff_example_sktd.sktd.en.json) | |
`<name>.sktd.json` | 1 | [`zif_aff_sktd_v1.intf.abap`](./type/zif_aff_sktd_v1.intf.abap) | [`sktd-v1.json`](./sktd-v1.json) | [`z_aff_example_sktd.sktd.json`](./examples/z_aff_example_sktd.sktd.en.json) |
Please also add the link to the markdown file.
# ensure the LF line endings for SKTD markdowns | ||
[*.md] | ||
charset = utf-8 | ||
end_of_line = lf | ||
insert_final_newline = true |
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.
This configuration must not run for all *.md files. For other *.md files trailing whitespaces shall still be checked
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.
You mean, the .md
file in the AFF for SKTD is allowed to have trailing whitespaces?
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.
Try adding to the original '.editorconfig'
[/file-formats/sktd/**/*.md]
trim_trailing_whitespace = unset
However, having trailing whitespaces might lead to undesired diffs.
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!
Yes, you are right. This is also what I mentioned earlier. See #270 (comment)
Currently, @uenal-akkaya tends to keep them anyway. But this is still in discussion ;) If we can avoid this exemption, it would be great. :)
No description provided.