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

Remove documentation for wptrunner as a standalone project #28806

Merged
merged 2 commits into from May 5, 2021

Conversation

foolip
Copy link
Member

@foolip foolip commented May 4, 2021

wptrunner 1.14 was released in 2015, and while it can be installed in a
virtualenv, these instructions should not be followed by anyone these
days.

Integrate some of it into from-local-system.md instead.

@wpt-pr-bot wpt-pr-bot added infra wptrunner The automated test runner, commonly called through ./wpt run labels May 4, 2021
@foolip foolip force-pushed the foolip/rm-wptrunner-usage branch from fe0572c to 6584210 Compare May 4, 2021 09:03
Copy link
Contributor

@jgraham jgraham left a comment

Choose a reason for hiding this comment

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

The installing part is definitely wrong/outdated, but it's possible that the usage parts aren't really documented elsewhere. Could be worth saving some of that if you have time.

@foolip
Copy link
Member Author

foolip commented May 4, 2021

@jgraham I'll comment on the bits that I thought you'd tell me to move somewhere else :)

tools/wptrunner/docs/usage.rst Show resolved Hide resolved
tools/wptrunner/docs/usage.rst Show resolved Hide resolved
tools/wptrunner/docs/usage.rst Show resolved Hide resolved
wptrunner 1.14 was released in 2015, and while it can be installed in a
virtualenv, these instructions should not be followed by anyone these
days.

Integrate some of it into from-local-system.md instead.
@foolip
Copy link
Member Author

foolip commented May 4, 2021

@jgraham do you want to review the salvaged (half rewritten) documentation?

@@ -152,7 +152,7 @@ customising the test run:
./wpt run --help

[A complete listing of the command-line arguments is available
here](command-line-arguments.md).
here](command-line-arguments.md#run).
Copy link
Member Author

Choose a reason for hiding this comment

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

I checked the build output and this actually broke stuff:

-<p><a class="reference internal" href="command-line-arguments.html"><span class="doc">A complete listing of the command-line arguments is available
-here</span></a>.</p>
+<p><a class="reference external" href="command-line-arguments.md#run">A complete listing of the command-line arguments is available
+here</a>.</p>

Copy link
Member Author

Choose a reason for hiding this comment

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

I found there are a few cases of broken links like this already that also need fixing...

Copy link
Member Author

Choose a reason for hiding this comment

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

Sent #28831, will apply the same fix here.

@foolip foolip merged commit 8238192 into master May 5, 2021
@foolip foolip deleted the foolip/rm-wptrunner-usage branch May 5, 2021 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs infra wptrunner The automated test runner, commonly called through ./wpt run
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants