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.

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

Ignore @ in code blocks when generating GitHub username links #3542

Closed
sarayourfriend opened this issue Dec 18, 2023 · 0 comments · Fixed by #3543
Closed

Ignore @ in code blocks when generating GitHub username links #3542

sarayourfriend opened this issue Dec 18, 2023 · 0 comments · Fixed by #3543
Assignees
@sarayourfriend
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation

Comments

@sarayourfriend
Copy link
Contributor

Description

In #3523 @AetherUnbound pointed out that the link usernames Sphinx plugin is transforming the @message notation inside the code block to a GitHub user link.

We should ignore the code block context in that Sphinx plugin.

Additional context

I'm looking at the code now for the link usernames Sphinx plugin and see that it's just a naive regex. That's not great for flexibility in cases like this 😢
@sarayourfriend sarayourfriend added 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 💻 aspect: code Concerns the software code in the repository 🧱 stack: documentation Related to Sphinx documentation and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Dec 18, 2023
This was referenced Dec 18, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sarayourfriend sarayourfriend

Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation
Projects
Openverse Backlog
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use more flexible implementation for user mention link documentation extension WordPress/openverse
1 participant
@sarayourfriend