✨ Making CodeSnips Pretty #294
Conversation
Signed-off-by: AdiAkhileshSingh15 <[email protected]>
|
@AdiAkhileshSingh15 Thank you for your PR! While this solves the issue, it appears that this is manipulating the original snip which we don't want because code snips are also displayed in the UI. I feel that there may not be a sane solution to this issue. |
|
@pranavgaikwad While this approach does indeed manipulate the original codesnip, it's important to note that it could result in an ugly UI only if maintaining the tab alignment at the start of each line is important, and is not maintained otherwise in the UI. |
|
@AdiAkhileshSingh15 UI displays code snippets in a code editor, if we take out spaces / tabs from original snip, that will mess up the alignment of lines |
|
@pranavgaikwad Okay! Then i guess we don't have a proper solution to this issue, if we can't manipulate the codesnip in violations. |
|
@AdiAkhileshSingh15 apologies, I should have researched this a little more before commenting on the issue. I think my comment is leading folks to believe default yaml marshaling is just going to work. Looks like it won't. Closing this PR...and updating issue. Please feel free to re-open or create new PR if you do solve this correctly. |
Ohkay! No problem. |
This pull request addresses issue #241 . It aims to improve the readability of the
codeSnipscript in the output YAML. I had previously submitted a pull request (#293 ) for the same issue, but that approach was quite lengthy and unconventional. Upon further investigation into why thecodesnipwasn't being marshaled into the desired '|' block scalar style literal, I discovered that any\s(whitespace) character following a\n(newline) caused the string to be treated as a regular string. To resolve this, I removed any spaces that appeared after the\nin theincident.CodeSnip.@pranavgaikwad Sir, can you please check this.