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

fix wrong default value for value_factor in README.md #1041

Closed
wants to merge 1 commit into from

Conversation

schmocker
Copy link

the default value for the parameter value_factor is documented as 0. But I think it should be 1.

the default value for the parameter value_factor is documented as 0. But I think it should be 1.
@ildar170975
Copy link
Collaborator

This is not correct.
The value of value_factor is used here:

const value_factor = 10 ** this.config.value_factor;

i.e. 0 value gives 1.

@ildar170975 ildar170975 closed this Dec 5, 2023
@ildar170975
Copy link
Collaborator

@schmocker
Do not get disappointed & keep improving the mini-graph-card ))

@schmocker
Copy link
Author

@ildar170975 oh ok I see, you are correct. Well that it's even more confusing since this is not a 'factor' but actually an 'exponent' which together with base 10 builds the actual factor. I would recommend to let the users define the factors directly (not the exponent) or rename it into something like value_factor_exponent and explain it a bit better.

@schmocker schmocker deleted the patch-1 branch December 5, 2023 19:21
@ildar170975
Copy link
Collaborator

I would recommend to let the users define the factors directly (not the exponent) or rename it into something like value_factor_exponent and explain it a bit better.

You are right, could be confusing. Check #591

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.

2 participants