Skip to content

Fixed minor formatting issue in introduction.md #870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ninadkhire
Copy link

While using Exercism for practice found that the ```swift ... ``` is visible in the introduction guide, which I thought is due to a formatting issue caused due to the surrounding tag ~~~~exercism/warrning ~~~~. Hence removed the tag to format it similarly as other code snippets.

Hope it will be helpful. Thanks.

Removed ~~~~exercism/warrning ~~~~ surrounding a paragraph and swift code snippet which was causing the ```swift ... ``` tags to be visible in the formatted md file.
Copy link
Contributor

Hello 👋 Thanks for your PR.

This repo does not currently have dedicated maintainers. Our cross-track maintainers team will attempt to review and merge your PR, but it will likely take longer for your PR to be reviewed.

If you enjoy contributing to Exercism and have a track-record of doing so successfully, you might like to become an Exercism maintainer for this track.

Please feel free to ask any questions, or chat to us about anything to do with this PR or the reviewing process on the Exercism forum.

(cc @exercism/cross-track-maintainers)

@@ -81,7 +80,7 @@ var mutVar = 0
inoutFunc(&mutVar, &mutVar)
// raises a compiler error: "Inout arguments are not allowed to alias each other"
```
~~~~
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may simply require a blank line between the block ends.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried adding a blank line between ``` and ~~~~, but it does not format the code snippet.

Also the text ~~~~exercism/warrning is it correct or it should be ~~~~exercism/warning? Get same formatting with both of them, though.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it should be caution

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The caution tag is not formatting the code either.

@@ -65,7 +65,6 @@ updateVersion(&dbRecord)
// dbRecord is now (3, "Exercism")
```

~~~~exercism/warrning
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the issue here is that this tag doesn't exist. To fix this, this tag should be: caution not warrning.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tags exercism/caution and caution are not working either.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants