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

Rename generic-sensor as sensors to align with specname #9895

Merged
merged 2 commits into from Mar 7, 2018

Conversation

@Honry
Copy link
Contributor

Honry commented Mar 7, 2018

reflect to #9830

@Honry

This comment has been minimized.

Copy link
Contributor Author

Honry commented Mar 7, 2018

@foolip, PTAL.

@foolip

foolip approved these changes Mar 7, 2018

Copy link
Contributor

foolip left a comment

Thanks! Please rename and merge, then we'll see about #9830.

@@ -1,25 +0,0 @@
[SecureContext, Exposed=Window]

This comment has been minimized.

Copy link
@foolip

foolip Mar 7, 2018

Contributor

Rather than removing this, can you rename it? In case #9830 has no differences, that'll leave a clearer history behind.

This comment has been minimized.

Copy link
@Honry

Honry Mar 7, 2018

Author Contributor

Sure.

@foolip

This comment has been minimized.

Copy link
Contributor

foolip commented Mar 7, 2018

If you want to rename https://github.com/w3c/web-platform-tests/tree/master/generic-sensor as well in this same PR, that'd be fine I think.

@Honry

This comment has been minimized.

Copy link
Contributor Author

Honry commented Mar 7, 2018

Sure, I will do that.

@w3c-bots

This comment has been minimized.

Copy link

w3c-bots commented Mar 7, 2018

Build PASSED

Started: 2018-03-07 07:10:55
Finished: 2018-03-07 07:43:42

Failing Jobs

  • safari:11.0
  • MicrosoftEdge:16.16299

View more information about this build on:

@Honry Honry changed the title Rename generic-sensor.idl as sensors.idl to align with specname Rename generic-sensor as sensors to align with specname Mar 7, 2018

@Honry Honry force-pushed the Honry:use-sensors-idl branch from b152b8e to 9f6ca5d Mar 7, 2018

@kaixinjxq

This comment has been minimized.

Copy link
Contributor

kaixinjxq commented Mar 7, 2018

LGTM

@Honry Honry merged commit 857f5c3 into web-platform-tests:master Mar 7, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@Honry Honry deleted the Honry:use-sensors-idl branch Mar 7, 2018

@Honry Honry referenced this pull request Mar 7, 2018

Closed

Update the sensors IDL file #9830

@Honry

This comment has been minimized.

Copy link
Contributor Author

Honry commented Mar 7, 2018

@foolip, @lukebjerring, I revisit the introduction guide at http://web-platform-tests.org/introduction.html to confirm how to define directories.

For W3C specs, these directories are typically named after the shortname of the spec (i.e. the name used for snapshot publications under /TR/)

So, we should use the shorname of publications under /TR/ rather than ED spec.
For Generic Sensor, its publication is https://www.w3.org/TR/generic-sensor/

PTAL, I suppose this will affect the code in auto-sync tool.

@Honry Honry restored the Honry:use-sensors-idl branch Mar 8, 2018

@Honry

This comment has been minimized.

Copy link
Contributor Author

Honry commented Mar 8, 2018

@foolip, @lukebjerring, friendly ping.

@foolip

This comment has been minimized.

Copy link
Contributor

foolip commented Mar 8, 2018

Hmm, so the rename has already happened now. I didn't realize the TR name is different, that seems annoying, and certainly for the purposes of auto-updating IDL it's simpler to pick a name based on the URL we're getting the IDL from rather than where a snapshot might live.

@jgraham @gsnedders what do you think about this? What should http://web-platform-tests.org/introduction.html#test-layout say, and should we do anything about cases that don't match what it says?

My preference is the IDs in https://github.com/foolip/day-to-day/blob/gh-pages/specs.json, because I've picked my favorite ones across the board :)

@gsnedders

This comment has been minimized.

Copy link
Contributor

gsnedders commented Mar 8, 2018

@foolip so I'm pretty sure it says the TR name because the TR name tends to be far more stable; I don't really have any strong preference but I'd rather not move things around too often.

@foolip

This comment has been minimized.

Copy link
Contributor

foolip commented Mar 8, 2018

I guess I think that once something has a TR name, then the github.io name should never change, unless the TR name changes as well. I think there are a few more mismatched cases like this, but I'm not going to go looking for them and seek to unify.

Unless someone notices, I guess leave this one as sensors?

@Honry

This comment has been minimized.

Copy link
Contributor Author

Honry commented Mar 9, 2018

Another instance of Battery Status API:

Latest published version:
http://www.w3.org/TR/battery-status/
Latest editor's draft:
https://w3c.github.io/battery/

IMO, an update for test suite directory will affect many referenced link in corresponding spec documentations(spec, wiki, WG charter). I'd prefer leave it as TR name.

@foolip

This comment has been minimized.

Copy link
Contributor

foolip commented Mar 9, 2018

I'm happy to leave that one alone too.

@Honry

This comment has been minimized.

Copy link
Contributor Author

Honry commented Mar 9, 2018

I'm happy to leave that one alone too.

Which one? Battery Status API?
Whatever we choose TR name or github.io name, we should definitely document the rule on http://web-platform-tests.org/introduction.html#test-layout

@Honry

This comment has been minimized.

Copy link
Contributor Author

Honry commented Mar 9, 2018

A few more mismatched cases, but not all:

Latest published version: https://www.w3.org/TR/mediacapture-streams/
Latest editor's draft: https://w3c.github.io/mediacapture-main/
Latest published version: https://www.w3.org/TR/appmanifest/
Latest editor's draft: https://w3c.github.io/manifest/
Latest published version: http://www.w3.org/TR/screen-capture/
Latest editor's draft: https://w3c.github.io/mediacapture-screen-share/
Latest Published Version: https://www.w3.org/TR/orientation-event/
Latest Editor's Draft: https://w3c.github.io/deviceorientation/

@foolip

This comment has been minimized.

Copy link
Contributor

foolip commented Mar 9, 2018

Yep, mediacapture-streams vs. mediacapture-main is a fun mismatch I've stumbled upon many times.

@Honry, can you file an issue about documenting this, adding the policy label? If you have a suggested, you can just send a PR.

Whatever "rule" we have, I think we still need to think critically about whether the names make sense. Just "manifest" for example isn't great, given that we also have tools/manifest/ and, well, the manifest.

@Honry

This comment has been minimized.

Copy link
Contributor Author

Honry commented Mar 9, 2018

@foolip, see #9937

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.