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.

Sign up for GitHub

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

Jump to bottom

docs(progress): corrected buffer value description #5080

Merged
merged 3 commits into from
Oct 24, 2023
Merged

docs(progress): corrected buffer value description #5080

merged 3 commits into from
Oct 24, 2023

Conversation

datvm
Copy link
Contributor

@datvm datvm commented Oct 13, 2023

Currently the doc says <md-linear-progress>'s buffer:

Buffer amount to display, a fraction between 0 and 1.

This is incorrect. It should be between 0 and max like value. See Lit playground or https://blazorwebmaterial.lukevo.com/progress

image

@asyncLiz asyncLiz changed the title Corrected buffer value description docs(progress): corrected buffer value description Oct 23, 2023
@asyncLiz asyncLiz self-assigned this Oct 23, 2023
asyncLiz
asyncLiz approved these changes Oct 23, 2023
View reviewed changes
Copy link
Collaborator

@asyncLiz asyncLiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

AndrewJakubowicz
AndrewJakubowicz requested changes Oct 23, 2023
View reviewed changes
Copy link
Collaborator

@AndrewJakubowicz AndrewJakubowicz left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great change, however this documentation is pulled from the source code, so in the future this change would be automatically reverted.

Could you please fix the documentation in the source:

material-web/progress/internal/linear-progress.ts

Line 18 in a5a6974

* Buffer amount to display, a fraction between 0 and 1.

Thank you so much!

@datvm
Copy link
Contributor Author

datvm commented Oct 23, 2023

@AndrewJakubowicz Thanks, that makes sense. I have added the commit you requested.

@datvm @AndrewJakubowicz
Update progress/internal/linear-progress.ts
271d1e8 
Co-authored-by: Andrew Jakubowicz <spyr1014@gmail.com>
@asyncLiz
Copy link
Collaborator

@datvm can you also check the CLA bot to make sure it's signed?

https://github.com/material-components/material-web/pull/5080/checks?check_run_id=17978517912

@AndrewJakubowicz
Copy link
Collaborator

@asyncLiz <sp****14​@gmail.com> is me sorry. GitHub randomly picks my personal email when doing suggestions unfortunately.
It's fine to proceed with that failing check.

@datvm
Copy link
Contributor Author

datvm commented Oct 23, 2023 •
edited
Loading

@asyncLiz Hi, I have signed the CLA before and the blockage isn't from me, it's from @AndrewJakubowicz

✅ 271d1e8 Author: @datvm ...
❌ 271d1e8 Co-Author: <sp****14​@gmail.com>

AndrewJakubowicz
AndrewJakubowicz approved these changes Oct 23, 2023
View reviewed changes
Copy link
Collaborator

@AndrewJakubowicz AndrewJakubowicz left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good. I also addressed the CLA. Thank you!

@copybara-service copybara-service bot merged commit b5bab09 into material-components:main Oct 24, 2023
2 checks passed
@datvm datvm deleted the correct-progress-buffer-doc branch October 24, 2023 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asyncLiz asyncLiz asyncLiz approved these changes

@AndrewJakubowicz AndrewJakubowicz AndrewJakubowicz approved these changes

Assignees

@asyncLiz asyncLiz

Labels
Ready for Google
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@datvm @asyncLiz @AndrewJakubowicz