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

Make parameter highlighting rules more permissive #4

Closed
leonhard-s opened this issue Apr 30, 2021 · 4 comments
Closed

Make parameter highlighting rules more permissive #4

leonhard-s opened this issue Apr 30, 2021 · 4 comments

Comments

@leonhard-s
Copy link
Owner

leonhard-s commented Apr 30, 2021

Many parameters end in numbers (p1, etc.). These are currently not picked up by the highlighting RegEx (see below).

image

Update:

Parameters using wildcard notation (*args, **kwargs) must be escaped for Sphinx to properly parse them. These escapes are currently not recognized by the highlighting rules.

@jeremyvital4
Copy link

how do i actually get this extension functioning once installed and enabled?

@leonhard-s
Copy link
Owner Author

Hi, the extension should be active immediately for any Python files as soon as it is installed, no further reload or configuration required.

Could you share an example of a docstring that does not get highlighted properly?

@leonhard-s leonhard-s changed the title Allow tags to end in numbers Make parameter highlighting rules more permissive Oct 28, 2021
leonhard-s added a commit that referenced this issue Oct 28, 2021
@leonhard-s
Copy link
Owner Author

Fixed in 36afe25.

@leonhard-s
Copy link
Owner Author

@jeremyvital4 Closing this issue as its original topic has been resolved - if you are still encountering issues getting the extension working, feel free to create a new issue for it.

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