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

Some trivial cleanups came up during another PR's review. #789

Merged
merged 2 commits into from
Sep 14, 2023

Conversation

qingxinwu
Copy link
Collaborator

@qingxinwu qingxinwu commented Sep 8, 2023

Some cleanups came up during another PR's review

  1. remove the extra new line after <xmp class="idl">
  2. Reword "Null or a [=string=] or a {{Promise}} or failure" to "Null, a [=string=], a {{Promise}}, or failure"

Also wrapped some very long lines. Nothing is changed, but just wrapped to new lines.


Preview | Diff

Also wrapped some very long lines.
@qingxinwu qingxinwu added the spec Relates to the spec label Sep 8, 2023
@qingxinwu qingxinwu changed the title Some cleanups came up during another PR's review. Some trivial cleanups came up during another PR's review. Sep 8, 2023
@@ -1840,7 +1845,9 @@ null |winningComponentConfig|:
<dd>|leadingBidInfo|'s [=leading bid info/scoring data version=] if it is not null,
{{undefined}} otherwise
</dl>
1. Let |igAd| be the [=interest group ad=] from |winner|'s [=generated bid/interest group=]'s [=interest group/ads=] whose [=interest group ad/render url=] is |winner|'s [=generated bid/ad descriptor=]'s [=ad descriptor/url=].
1. Let |igAd| be the [=interest group ad=] from |winner|'s [=generated bid/interest group=]'s
[=interest group/ads=] whose [=interest group ad/render url=] is |winner|'s
Copy link
Collaborator

Choose a reason for hiding this comment

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

I still think all of these lines should be wrapped properly such that the wrapped line starts exactly under the first character after the number marker on the line above. Actually, you did this below a bit so this is inconsistent. It doesn't really matter, but the entire spec being consistent would be good.

Copy link
Collaborator Author

@qingxinwu qingxinwu Sep 12, 2023

Choose a reason for hiding this comment

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

It's a little unfortunate that it requires indenting the line with tabs plus 1 space to wrap it that way, which does not sound like the best way to indent. I can make the indents in this PR consistent at least, whichever format you'd recommend.

There are some other inconsistencies in the spec as well, such as how a method definition is formatted, maximum length of a line, etc., after more people started contributing to the spec.
Definitely be good to update these, but since it'll be a huge change that might cause some rebase issues (and don't have much bandwidth at this moment), will leave it to a later time when we don't need to modify the spec very often anymore. I can open an issue for this (formatting the spec) if you'd like that.

I remember you have a command line tool that formats specs, do you recommend using it, or I need to manually format the spec?

Copy link
Collaborator

Choose a reason for hiding this comment

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

It's not a big deal. Consistency is nice, but this is a minor thing ultimately. The tool will not cover this case unfortunately :(

@JensenPaul JensenPaul merged commit c277235 into WICG:main Sep 14, 2023
1 check passed
github-actions bot added a commit that referenced this pull request Sep 14, 2023
SHA: c277235
Reason: push, by JensenPaul

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot added a commit to brusshamilton/turtledove that referenced this pull request Sep 14, 2023
SHA: c277235
Reason: push, by brusshamilton

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@qingxinwu qingxinwu deleted the cleanup branch September 15, 2023 14:18
github-actions bot added a commit to qingxinwu/turtledove that referenced this pull request Sep 15, 2023
SHA: c277235
Reason: push, by qingxinwu

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec Relates to the spec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants