10000 Code fence boxes for data should have `code` tag · Issue #58 · UBC-DSCI/introduction-to-datascience-python · GitHub
[go: up one dir, main page]
Skip to content

Code fence boxes for data should have code tag #58

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.

Sign up for GitHub

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

Jump to bottom
8000 Closed
trevorcampbell opened this issue Dec 18, 2022 · 4 comments
Closed

Code fence boxes for data should have code tag #58

trevorcampbell opened this issue Dec 18, 2022 · 4 comments
Labels
bug Something isn't working needs-investigation Further information is requested

Comments

@trevorcampbell
Copy link
Contributor
trevorcampbell commented Dec 18, 2022 •
edited
Loading

In certain places in the text, we load dataframes and typeset them in code fences. But if we just use ``` as the first fence, the box will get code-like syntax highlighting (which isn't desirable for data frames). We need to look through the book and make sure code fences for data frames start like ```code (which, unintuitively, typesets without syntax highlighting). I am fixing this in Ch 1 and 2 as part of #48 and #49 but we should do a global pass after polish round is done.
@trevorcampbell trevorcampbell added bug Something isn't working needs-investigation Further information is requested labels Dec 18, 2022
@joelostblom
Copy link
Contributor

I think we can also use text instead of code if we want it to be more semantically intuitive (but not difference in output I believe)

@trevorcampbell
Copy link
Contributor Author

I tried text (that was the obvious choice) and it didn't work! Still weird syntax highlighting. If text indeed works, I would prefer it.

(maybe this was in a flurry of activity and I wasn't paying enough attention to the build though...)

@trevorcampbell
Copy link
Contributor Author

As a side note, jupyterbook spits out a warning that it doesn't understand code tag -- which is why you don't get any syntax highlighting in that case ;) I imagine text should work, but needs investigation and we can punt it for later.

@trevorcampbell
Copy link
Contributor Author

resolved in #189

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working needs-investigation Further information is requested
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@joelostblom @trevorcampbell
0