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

Showing glossary terms with an apostrophe won't work #833

Closed
frenck opened this issue Jan 8, 2024 · 3 comments
Closed

Showing glossary terms with an apostrophe won't work #833

frenck opened this issue Jan 8, 2024 · 3 comments
Labels
bug Something isn't working

Comments

@frenck
Copy link

frenck commented Jan 8, 2024

Description

Showing glossary terms that contain an apostrophe stopped working.

For example: glossary.md:

:::{glossary}
Spook's influence
: Something
:::

When trying to reference it using:

{term}`Spook's influence`

Myst reports it as non-existing. This used to work before.

Asking around on Discord I was told to make an issue, as it "looks like a problem with converting to smart typography, which we did introduce a few months ago".

Proposed solution

Hehe.. let's not ask for the captain obvious here :)

Additional notes

CleanShot 2024-01-08 at 21 49 49@2x

@frenck frenck added the bug Something isn't working label Jan 8, 2024
Copy link

welcome bot commented Jan 8, 2024

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@agoose77
Copy link
Collaborator

agoose77 commented Jan 9, 2024

Yes, the reason that the reference breaks is because markdown-it (the underlying tokenizer) applies the smartquote transform, subtly changing the deflist identifier. #727 introduced this change. I've not bisected to ensure that this is the PR that breaks things, but it looks right.

Pinging @rowanc1 (PR author) for ideas here. My guess is that we might want to lift the smart-quotes to the MyST level so that we preserve more of the original markup.

@rowanc1
Copy link
Member

rowanc1 commented Mar 26, 2024

Fixed in #1034. Thank you for the bug report!

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants