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

Dotted path relative references #123

Closed
wants to merge 1 commit into from
Closed

Dotted path relative references #123

wants to merge 1 commit into from

Conversation

lmmx
Copy link

@lmmx lmmx commented Jan 13, 2024

I have begun to develop the new simplified form of relative cross-reference and think it should default to on, because as I see it this cannot cause backward incompatibility: it was invalid to use a .-prefixed reference in a docstring before now, so surely there is no pre-existing code whose behaviour we need to preserve? Can I confirm that's the case?

  • feat(relative-refs): add and document a new relative_crossrefs config setting

This PR will close #27:

@pawamoy
Copy link
Member

pawamoy commented Jan 13, 2024

Can I confirm that's the case?

Sounds right. And in that case, we don't even need a setting, right?

Could you share how you plan to implement this? I don't want to gate-keep eternally but I might have reserves regarding an implementation directly within the Python handler and not the autorefs plugin.

@lmmx
Copy link
Author

lmmx commented Jan 13, 2024

My thoughts exactly, adding needless configuration is just introducing complexity, I will remove it.

I was just ramping up to consider that question! Apologies as I just came to make this PR because I thought your comment on the autorefs plugin repo was telling me to do that haha, I'd be happy to contribute wherever you think it should go.

Rereading what you said I now see it was supposed to imply a PR should be made to autorefs, apologies.

I still want to implement this, particularly in a generic way, through autorefs

@lmmx
Copy link
Author

lmmx commented Jan 13, 2024

Closing in favour of a direct modification to autorefs instead

Update - new PR is here:

@lmmx lmmx closed this Jan 13, 2024
@lmmx lmmx deleted the relative-refs-lm branch January 13, 2024 15:02
@pawamoy
Copy link
Member

pawamoy commented Jan 13, 2024

Sorry for the confusion! And no worries 🙂 Thanks a lot for contributing to mkdocstrings and friends 😄 I'll try to unlock some time soon to elaborate a bit more on what would be need in autorefs (and possibly handlers too) to make this work.

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.

Relative cross-references
2 participants