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

New pages: HTMLInputElement step, name, and defaultValue properties #35614

Merged
merged 4 commits into from
Aug 28, 2024
Merged

New pages: HTMLInputElement step, name, and defaultValue properties #35614

merged 4 commits into from
Aug 28, 2024

Conversation

estelle
Copy link
Member

@estelle estelle commented Aug 28, 2024

part of #35544

@estelle estelle requested a review from a team as a code owner August 28, 2024 04:03
@estelle estelle requested review from Elchi3 and removed request for a team August 28, 2024 04:03
@github-actions github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Aug 28, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 28, 2024 •
edited
Loading

Preview URLs

(comment last updated: 2024-08-28 20:06:59)

Josh-Cena
Josh-Cena requested changes Aug 28, 2024
View reviewed changes
files/en-us/web/api/htmlinputelement/defaultvalue/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/htmlinputelement/defaultvalue/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/htmlinputelement/name/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/htmlinputelement/step/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/htmlinputelement/step/index.md Outdated Show resolved Hide resolved
@Josh-Cena
Copy link
Member

In general, IDL properties are actually quite easy to document because all you have to say is "it reflects the attribute blah. For all valid values and what they do, read the HTML documentation instead", and then give a three-line example demonstrating reading, and occasionally writing, the property.

@estelle estelle requested a review from Josh-Cena August 28, 2024 16:42
@estelle
Copy link
Member Author

estelle commented Aug 28, 2024

give a three-line example demonstrating reading, and occasionally writing, the property.

Thanks @Josh-Cena. That will make this project much easier ;)

Josh-Cena
Josh-Cena approved these changes Aug 28, 2024
View reviewed changes
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Just one nit, but I think this is a pattern generalizable to most reflection properties.

@estelle estelle merged commit bc14109 into main Aug 28, 2024
9 checks passed
@estelle estelle deleted the htmlinputattrs branch August 28, 2024 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Josh-Cena Josh-Cena Josh-Cena approved these changes

@Elchi3 Elchi3 Awaiting requested review from Elchi3 Elchi3 is a code owner automatically assigned from mdn/yari-content-web-api

Assignees
No one assigned
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@estelle @Josh-Cena