Closed tumultuous1 closed 1 year ago
Hello tumultuous1, Thank you for this comment. While reviewing this, I am not able to replicate the issue, can you please let me know which ALH's are having these issues so we can further investigate. Also, can you provide your thoughts on a solution via a pull request so we can further test.
Thank you and I look forward to your feedback.
The issue as I see it, is that by not implementing code blocks flush w/code, and instead including 4 spaces/indent within the code block, what we are saying is that (when rendered, even within Github) ...we are adding those 4 spaces into the command.
In GH, we thus end up with a weirdly formatted code block with extraneous leading spaces:
Contrast this against other code blocks within this repo where code blocks are flush, and thus have no extraneous leading spaces:
So, when the student clicks to autotype this code block into the VM - that results in 4 extra spaces being typed into the Command-window within the VM, and only then the command we actually want. Believe it or not, Students and Instructors will call in tickets on this behavior: In addition to being weirdly formatted (one would never intentionally type in leading spaces before typing the desired command) ...in some cases, particular when things like Intellisense may be enabled in Cloudshell, or other apps such as VS Code, the extraneous 4 spaces typed into the app can cause issues.
I understand, of course, that all ALHs may not use markdown parsers identical to Github's, but in any case....consistency of formatting within a repo's Instructions set is also highly desirable. Parser differences can be corrected by ALHs to fix...but if something like a code block formatting varies throughout the .md documents - sometimes formatted flush left, sometimes formatted with extraneous spaces, etc., correcting it can become a chore in and of itself for ALHs.
To fix, I would 'correct' any code blocks to be flush. i.e
code line1
code line2
Thank you for the explanation. I will review the code and make the necessary changes.
Module 301 (Exercise 1, Task 4, Step 5) Module 801 (Task 1, Step 13) (Task 2, Steps 7,11,12,13 Module 803 (Task 1, Steps 8,14)
The backticks need to have enough spaces to match the code. This will cause issues with ALHs when the .md is parsed. Example in screenshot below.