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

Update project: Autolink References #233

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rhshadrach
Copy link

@rhshadrach rhshadrach commented Jul 7, 2024

What kind of change does this PR introduce?

  • Add a project
  • Update a project
  • Remove a project
  • Add or update a category
  • Change configuration
  • Documentation
  • Other, please describe:

Description:

The package autolink-references-mkdocs-plugin is currently broken (see here) and I've not been able to get responses from the author. I've forked the project and implemented the fix.

This PR is currently replacing autolink-references-mkdocs-plugin with my fork mkdocs-argref-plugin. If this is inappropriate, I can rework this to instead add mkdocs-argref-plugin alongside autolink-references-mkdocs-plugin. But I thought linking to a broken project is not desired.

Checklist:

  • I have read the CONTRIBUTING guidelines.
  • I have not modified the README.md file. Projects are only supposed to be added or updated within the projects.yaml file since the README.md file is automatically generated.

@pawamoy
Copy link
Sponsor Collaborator

pawamoy commented Jul 7, 2024

Thanks, I'll try to review everything soon and get back to you :)

@pawamoy
Copy link
Sponsor Collaborator

pawamoy commented Jul 9, 2024

OK, everything looks good. However I'm not comfortable replacing the original plugin. Last commit was 7 months ago, sure, but that's not enough IMO to consider it unmaintained (even if there's an outstanding bug), especially given we have other projects listed here that have seen their last commit many years ago. Therefore, and if you don't mind, I'd prefer that you add your plugin to the list rather than replace the original one. WDYT 🙂?

@rhshadrach
Copy link
Author

Sounds good to me.

Last commit was 7 months ago, sure, but that's not enough IMO to consider it unmaintained (even if there's an outstanding bug),

I do want to stress that this isn't just "a bug". The bug makes the package almost entirely non-functional. Even worse, it will look like it's working for the first two references, but then will stop working on any more. Also that I've reached out to the maintainer in multiple ways.

But I understand the reservations on removing the package, will update this PR in the next day or two.

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.

None yet

2 participants