Skip to content

Code snippets in instructions are ambiguous #9

Description

@kytrinyx

One of the instructions for a String drill said:

Take this string and turn it into a symbol. The output should be
:mouse:

Knowing beginners, there is reason to believe that they might expect the output to be :mouse: rather than :mouse.

Would it be worth adding backticks around code snippets to make it clear what is code vs what is English text?

UPDATE: I had to put backticks in the quoted text, because GitHub turns :mouse: into 🐭.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions