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 README.md #10

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

Conversation

ExtremeKiller145
Copy link

I made it clearer what this project does by explicitly mentions it. I am not 100% sure that it works as I described since I didn't read the code, but that is how it seemed to work in practice.

I made it clearer what this project does by explicitly mentions it. I am not 100% sure that it works as I described since I didn't read the code, but that is how it seemed to work in practice.
@MalcolmMielle
Copy link
Owner

Thanks for the PR and helping with the package README.

I'm not sure what you meant by "only at its declaration."? What the package does is that it has a panel of color for variables and will give each individual variable the same color in the file. So if you have:

foo = 1
foon = foo + 1

def test(self, test: int) -> None:
    return test + 100

foo will have its own color (at line 1 and line 2), foon will have its own color, and test will have its own color, but only the argument test of the function test will be colorized (and also at line 5) and not the function name. So you could have, for example:

(red)foo = 1
(blue)foon = (red)foo + 1

def test(self, (green)test: int) -> None:
    return (green)test + 100

What part of the README/package are you trying to clarify :)? Maybe the section you added would be even better if a section on how to parameterize the colors was added to the README?

@MalcolmMielle MalcolmMielle added the question Further information is requested label Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants