question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Apostrophe rendering as left smart-quote instead of right, when the possessive noun has a tooltip.

See original GitHub issue

Contribution guidelines

I’ve found a bug and checked that …

  • … the problem doesn’t occur with the mkdocs or readthedocs themes
  • … the problem persists when all overrides are removed, i.e. custom_dir, extra_javascript and extra_css
  • … the documentation does not mention anything about my problem
  • … there are no open or closed issues that are related to my problem

Description

If Word is defined as an abbreviation using the *[Word]: syntax, then Word's (e.g., this Access Group's permissions) renders with a left smart-quote instead of an apostrophe.

Expected behaviour

I would expect this markdown source:

Each section of the editor controls an access group's ability to view, and actions within, the listed pages.
Select the checkboxes to allow the appropriate actions.

*[access group]: Access groups allow admin users to<br>assign custom permissions to all<br>users assigned to that group.

To render wie so:

image

Actual behaviour

It is rendering like this instead:

image

Steps to reproduce

  1. Put the above markdown source in a file.
  2. Use the below configuration.
  3. mkdocs serve

Package versions

  • Python: 3.10.0
  • MkDocs: 1.4.0
  • Material: 8.5.6+insiders.4.25.2

Configuration

site_name: My Documentation
site_url: ""

plugins:
    - search:
        separator: '[\s\-\./\\]+'
    - offline

theme:
  name: material
  font:
    text: Montserrat
    code: Noto Sans Mono
  language: en

extra_javascript:
  - assets/mathjax/mathjax.js
  - assets/mathjax/tex-mml-chtml.js

markdown_extensions:
    - abbr: {}
    - smarty: {}
    - toc: {}
    - tables: {}
    - attr_list: {}
    - pymdownx.tabbed: {}
    - pymdownx.snippets: {}
    - meta: {}
    - md_in_html: {}
    - admonition: {}
    - pymdownx.details: {}
    - pymdownx.superfences: {}
    - def_list: {}
    - pymdownx.emoji:
        emoji_index: !!python/name:materialx.emoji.twemoji
        emoji_generator: !!python/name:materialx.emoji.to_svg
    - pymdownx.caret: {}
    - pymdownx.mark: {}
    - pymdownx.tilde: {}
    - pymdownx.keys: {}
    - footnotes: {}
    - pymdownx.arithmatex:
        generic: true

System information

  • Operating system: macOS Monterey 12.6
  • Browser: Chrome 107.0.5304.110, Safari 15.6.1, Firefox 106.0.2

Issue Analytics

  • State:closed
  • Created 10 months ago
  • Comments:7 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
facelessusercommented, Nov 16, 2022

That’s find as a stopgap solution, or if you just don’t mind maintaining such a solution, but ideally, an issue should be created on the original extension. There are all sorts of contractions, and a more intelligent way to address them would be ideal. I’m sure more issues like this will crop up in the future.

1reaction
facelessusercommented, Nov 16, 2022

This is not a bug with Material but an issue with the smarty extension. Personally, I always turn off smart_quotes when using smarty for this and other reasons. I’m sure it could be improved though, but an issue would have to be filed upstream.

Read more comments on GitHub >

github_iconTop Results From Across the Web

“Smart” Apostrophes (CMOS 6.117)
This all-purpose character has three roles: apostrophe, left single quotation mark, and right single quotation mark. 'Here's an example of ...
Read more >
The RIght-Hand Curly Apostrophe - McQuillen Creative Group
The graphic design experts at McQuillen Creative in Aberdeen, SD illustrate how to produce a proper right-hand curly apostrophe.
Read more >
FINDING AND FIXING APOSTROPHE ERRORS
An apostrophe indicates that one or more letters have been left out. ... The word “its” with no apostrophe is a possessive pronoun,...
Read more >
Correct Apostrophe Usage for Omitted Letters and Possessives
Apostrophes are also used in possessives. The basic rule is to add 's, whether the noun is singular or plural. Claire's book. Nate's...
Read more >
Attributive or Possessive | The Editor's Blog
Deciding between attributive or possessive nouns can be hard, but there are tips to help you decide. Learn when to include the apostrophe...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found