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

Add language tags to code samples #27

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

abhro
Copy link

@abhro abhro commented Apr 15, 2024

No description provided.

Copy link
Member

@ablaom ablaom left a comment

Choose a reason for hiding this comment

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

Curious about the context in which this makes any difference. I thought four spaces was equivalent to fencing, and in Julia, the julia in "```julia" is redundant. Happy to be corrected.

Certainly this PR does not harm.

@abhro
Copy link
Author

abhro commented Apr 19, 2024

Hello! Thank you for commenting and approving! For most cases an untagged fence is the same as indented, but doesn't allow for language specification. In this case that's not a problem, but I added the first fence because of consistency within the code file. For the other changes, I was checking MLJ documentation and came across this model (https://alan-turing-institute.github.io/MLJ.jl/dev/models/KMeans_Clustering/) and several others from this package, and it seems Documenter.jl didn't pick up the language from the fence automatically. This is a minor issue with syntax highlighting, but I figured it would be helpful to have it there. Cheers!

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.

2 participants