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

Fix MkDocs reference share buttons #36

Merged
merged 2 commits into from
Jan 21, 2024
Merged

Fix MkDocs reference share buttons #36

merged 2 commits into from
Jan 21, 2024

Conversation

glenn-jocher
Copy link
Member

No description provided.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

PR Type: Enhancement

PR Summary: The pull request introduces changes to the MkDocs plugin, specifically modifying the CSS class used to append content and streamlining the generation of author links. The changes aim to enhance the functionality of reference share buttons within the documentation.

Decision: Comment

📝 Type: 'Enhancement' - not supported yet.
  • Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
📝 Complexity: the changes are too large or complex for Sourcery to approve.
  • Unsupported files: the diff contains files that Sourcery does not currently support during reviews.

General suggestions:

  • Ensure that the new CSS class '.md-content__inner' is consistently used throughout the project and that any associated CSS or JavaScript has been updated to reflect this change.
  • Consider maintaining descriptive variable names for readability and maintainability, as the change from 'author' to 'a' in the list comprehension reduces clarity.
  • Review the changes to ensure they align with the overall design and functionality of the MkDocs plugin, and that they do not introduce any regressions or unintended side effects.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

plugin/main.py Show resolved Hide resolved
@glenn-jocher glenn-jocher merged commit 6d146f8 into main Jan 21, 2024
1 check passed
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.

1 participant