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

Create a double-to-single backtick migrator #24

Open
larsoner opened this issue Jun 3, 2024 · 1 comment
Open

Create a double-to-single backtick migrator #24

larsoner opened this issue Jun 3, 2024 · 1 comment
Assignees

Comments

@larsoner
Copy link

larsoner commented Jun 3, 2024

In MNE-Python (and it sounds like elsewhere), one way of working around single-backtick parameter names not cross-linking and emitting nitpicky warnings etc. has been to use double-backticks. We should write a little utility to go through docstrings, find parameters, look for double-backtick-enclosed versions of those, and replace with single backticks.

I can work on this at some point perhaps! I have code to test it on 🙂

@larsoner larsoner self-assigned this Jun 3, 2024
@bsipocz
Copy link
Member

bsipocz commented Jun 3, 2024

astropy and related projects also double backticked all parameter names, I can offer astroquery and pyvo for testing ground if we need some smaller projects.
Though any such PRs will touch a lot of files/lines, so a tool that does it incrementally, just on the diffed files would be nice, too.

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

No branches or pull requests

2 participants