Skip to content
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

fix the disable comments for the markdown formatter #1493

Merged

Conversation

DerMolly
Copy link
Contributor

According to docs these comments should look like this. Hopefully this will prevent them from showing up on the exercism page e.g. https://exercism.org/tracks/elixir/exercises/rpn-calculator in the section "Try/Rescue"

CleanShot 2024-06-11 at 23 59 25@2x

See:
https://hexdocs.pm/markdown_code_block_formatter/readme.html#disabling-the-formatter-for-specific-code-blocks

According to docs these comments should look like this. Hopefully this will prevent them from showing up on the exercism page e.g. https://exercism.org/tracks/elixir/exercises/rpn-calculator in the section "Try/Rescue"

See:
https://hexdocs.pm/markdown_code_block_formatter/readme.html#disabling-the-formatter-for-specific-code-blocks
Copy link
Contributor

Thank you for contributing to exercism/elixir 💜 🎉. This is an automated PR comment 🤖 for the maintainers of this repository that helps with the PR review process. You can safely ignore it and wait for a maintainer to review your changes.

Based on the files changed in this PR, it would be good to pay attention to the following details when reviewing the PR:

  • General steps

    • 🏆 Does this PR need to receive a label with a reputation modifier (x:size/{tiny,small,medium,large,massive})? (A medium reputation amount is awarded by default, see docs)
  • Any exercise changed

    • 👤 Does the author of the PR need to be added as an author or contributor in <exercise>/.meta/config.json (see docs)?
    • 🔬 Do the analyzer and the analyzer comments exist for this exercise? Do they need to be changed?
    • 📜 Does the design file (<exercise>/.meta/design.md) need to be updated to document new implementation decisions?
  • Practice exercise changed

    • 🌲 Do prerequisites, practices, and difficulty in config.json need to be updated?
    • 🧑‍🏫 Are the changes in accordance with the community-wide problem specifiations?
  • Concept exercise changed

    • 🌲 Do prerequisites and practices in config.json need to be updated?
    • 📖 Does the concept introduction provide all necessary information to solve this exercise?
  • Concept changed

    • 👤 Does the author of the PR need to be added as an author or contributor in <concept>/.meta/config.json (see docs)?
    • 📖 Does the concept introduction provide all necessary information to solve this exercise?

Automated comment created by PR Commenter 🤖.

@angelikatyborska
Copy link
Contributor

Ooops, I didn't notice that they actually show up on the website 🙈

If we change them from [] to [//], then running ./bin/configlet generate moves the fake comment to the end of the generated file (exercises/concept/rpn-calculator/.docs/introduction.md). Which causes the CI to fail (the CI checks that all autogeneated files are up to date), and makes the comment useless because the comment's position in the file is important.

@ErikSchierboom can you advise, why do empty links without an url show up on the website? E.g. https://exercism.org/tracks/elixir/exercises/leap/approaches/operators

Screenshot 2024-06-12 at 06 20 12

@ErikSchierboom
Copy link
Member

@ErikSchierboom can you advise, why do empty links without an url show up on the website?

It looks like that is the default behavior of our markdown library

@DerMolly
Copy link
Contributor Author

So should we remove the comments altogether then? Or do you think it feasable to keep them and make them work like intended. Maybe some option in the markdown library / configlet or something.

@ErikSchierboom
Copy link
Member

Maybe some option in the markdown library

I'm positive there isn't such an option available. We could manually override the default behavior, although I'm not sure that is possible. @iHiD what do you think?

@angelikatyborska
Copy link
Contributor

We'll have to live with forced autoformatting in concept introductions 🤷 it's not the worst thing ever. I pushed one commit that updates that one code snippet that was resisting formatting before.

@DerMolly thank you for bringing this issue to our attention 🙏

@angelikatyborska angelikatyborska merged commit a658836 into exercism:main Jun 17, 2024
9 of 10 checks passed
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