CompSci: Fix code blocks, Markdown formatting, and prose #837
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* `protocol` does not include `:` * `host` does not include `/` after `protocol` or before `path` * `path` includes initial `/` after `host`
Use the same name and array size as the examples from other languages
In example code blocks, use functions named `f()` and `g()`, consistent with the rest of the description, instead of `F()` and `f()`.
Enki's markdown implementation formatted a line differently than the original author intended. This patch is a workaround which does not create the intended HTML structure, but does create the intended formatting visually. Intended output: <em>249 Oak <strong>enkidevs#1</strong></em> Old rendering: *249 Oak <strong>enkidevs#1*</strong> New rendering: <em>249 Oak</em> <em><strong>enkidevs#1</strong></em> (or `<strong>` may be on the outside, but the concept is the same)
Somehow, the Markdown parser is rendering this question as if it were a list item, and thus as the correct answer to the revision question, instead of as the question itself. Hopefully, changing this line to an `<h4>` will prevent the misinterpretation. This will clarify the question for the user and cause the grader to see the *intended* answer as the correct one.
Two ordered lists (in theory) were being rendered by the markdown parser as a single paragraph, all the items running together. Now, by adding a blank line between each list and the preceding paragraph, they should be rendered as real ordered lists and be easier to read.
lizTheDeveloper
suggested changes
Jun 11, 2018
There was a problem hiding this comment.
These updates are so appreciated, thanks for fixing those broken questions! Also the networking intros are so much clearer now.
There's one formatting thing that has to be fixed, which I noted in the review. If you don't have time I'll probably pull these over on Friday and just fix it, otherwise I'll merge once that one thing is fixed.
💯 ✨ 🙌
| @@ -47,7 +47,7 @@ The causes of packet loss vary, yet the most common ones are: | |||
| --- | |||
| ## Revision | |||
|
|
|||
| _Packet loss_ is measured | |||
| #### *Packet loss* is measured | |||
There was a problem hiding this comment.
Our format needs a third-level header here to specify the "headline", or it will throw an error / not have a headline
There was a problem hiding this comment.
Absolutely, I'll get that taken care of! I look forward to continuing to contribute!
ghost
assigned
lizTheDeveloper
approved these changes
Jun 12, 2018
|
🎆 You're the best! Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These changes fit into 3 main categories, detailed below.
Code blocks
Formatting / Markdown rendering
a café at *249 Oak **#1***turned into:I addressed this by making separate italic and bold italic sections which should now be rendered as:
a café at <em>249 Oak</em> <em><strong>#1</strong></em>(imperfect, but gets the job done)._Packet loss_ is measured) was being parsed as if it were a list item, for some reason, and was thus listed as a potential answer (the "correct" answer, in fact):I changed this question to an
<h4>so that it will no longer be interpreted as a list item.I added a blank line between the lists and their preceding paragraphs so that they should be rendered as
<ol>s now.Prose