Proofread #28
Draft
Proofread #28
Conversation
This file contains hidden or 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
Not everyone starting to use Robot Framework is a python developer so not everyone knows what virutalenv is or how to use it. I'm also new, so suggestions to this commit are totallly welcome.
I tried to simplify a few things. I replaced the hyphens with em dashes.
Headings help readers by breaking up and categorizing the various paragraphs. I also removed a redundant section.
Author
|
I force-pushed because I accidentally made all the commits so far with the wrong account. I've gone back and amended each to have the correct account now. |
Contributor
|
Hi @TurekBot! Thanks for showing interest in this project! Overall the changes look very good. Feel free to change the PR state to If you want, you can of course proofread all exercise files and add them to this PR, but naturally the review process will then take a lot more time. |
The solution checker doesn't work well. It assumes a very specific solution, down to the line and word. I've replaced the solution checker with a solution demonstrater, so the learner can compare their solution with ours.
The summary element is usually shorter; now it is.
"Read this manual!" doesn't seem like an excellent way to approach it. However, I'm totally open to putting it back in a better way.
If there is a better formatting for tips and warnings than a blockquote, let me know and I'd be happy to change it.
(Yeah, "exampleate" probably isn't a word, but it gets the message across, doesn't it?)
I figure it should be commented out since "..." is used meaningfully in other places in RF; and we don't intend it that way here.
asimell
reviewed
Apr 20, 2022
asimell
reviewed
Apr 20, 2022
asimell
reviewed
Apr 20, 2022
As @asimell explained (in eficode-academy#28), we want to point the learner to the user guide for later when they get stuck. I've reworded it to make that clearer.
I left some rewording of the message, but removed the part that demonstrates our solution. This leaves the checker intact, as requested by @asimell in PR eficode-academy#28. This check still needs to be improved, as also described by him, but that's another matter.
I'll add similar links in the other sections as I go on reviewing.
The previous message made it seem like the whole table section ended with asterisks, but we know that it's only the table header that does.
@asimell rightly pointed out that each file should only have a single "Exercise" header in PR eficode-academy#28. This commit rewords the smaller of the two "Exercise" headers, leaving only one.
# Conflicts: # setup/01-manual_testing.py
This was referenced Mar 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I have a background in technical editing, so I thought I'd lend a hand and fix up any issues I found while going through.
Suggestions are welcome!