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 requested review from jgraham and LukeZielinski May 4, 2021
@foolip foolip force-pushed the foolip/rm-wptrunner-usage branch from fe0572c to 6584210 May 4, 2021
@jgraham
jgraham approved these changes May 4, 2021
Copy link
Contributor

@jgraham jgraham left a comment

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 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 foolip force-pushed the foolip/rm-wptrunner-usage branch from 6584210 to de157b6 May 4, 2021
@wpt-pr-bot wpt-pr-bot added the docs label May 4, 2021
@wpt-pr-bot wpt-pr-bot requested a review from sideshowbarker May 4, 2021
@foolip
Copy link
Member Author

@foolip 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).

This comment has been minimized.

@foolip

foolip May 5, 2021
Author Member

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>

This comment has been minimized.

@foolip

foolip May 5, 2021
Author Member

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

This comment has been minimized.

@foolip

foolip May 5, 2021
Author Member

Sent #28831, will apply the same fix here.

@jgraham
jgraham approved these changes May 5, 2021
@foolip foolip merged commit 8238192 into master May 5, 2021
42 checks passed
42 checks passed
@github-actions
build-and-publish
Details
@github-actions
build-and-tag
Details
@azure-pipelines
Azure Pipelines Build #20210505.18 succeeded
Details
@azure-pipelines
Azure Pipelines (./wpt test-jobs) ./wpt test-jobs succeeded
Details
@azure-pipelines
Azure Pipelines (affected tests without changes: Safari Technology Preview) affected tests without changes: Safari Technology Preview succeeded
Details
@azure-pipelines
Azure Pipelines (affected tests: Safari Technology Preview) affected tests: Safari Technology Preview succeeded
Details
@azure-pipelines
Azure Pipelines (infrastructure/ tests: macOS) infrastructure/ tests: macOS succeeded
Details
@azure-pipelines
Azure Pipelines (tools/ unittests: Windows + Python 3.6) tools/ unittests: Windows + Python 3.6 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/ unittests: Windows + Python 3.9) tools/ unittests: Windows + Python 3.9 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/ unittests: macOS + Python 3.6) tools/ unittests: macOS + Python 3.6 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/ unittests: macOS + Python 3.9) tools/ unittests: macOS + Python 3.9 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/wpt/ tests: Windows + Python 3.6) tools/wpt/ tests: Windows + Python 3.6 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/wpt/ tests: Windows + Python 3.9) tools/wpt/ tests: Windows + Python 3.9 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/wpt/ tests: macOS + Python 3.6) tools/wpt/ tests: macOS + Python 3.6 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/wpt/ tests: macOS + Python 3.9) tools/wpt/ tests: macOS + Python 3.9 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/wptrunner/ unittests: Windows + Python 3.6) tools/wptrunner/ unittests: Windows + Python 3.6 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/wptrunner/ unittests: Windows + Python 3.9) tools/wptrunner/ unittests: Windows + Python 3.9 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/wptrunner/ unittests: macOS + Python 3.6) tools/wptrunner/ unittests: macOS + Python 3.6 succeeded
Details
@azure-pipelines
Azure Pipelines (tools/wptrunner/ unittests: macOS + Python 3.9) tools/wptrunner/ unittests: macOS + Python 3.9 succeeded
Details
@azure-pipelines
Azure Pipelines (wpt.fyi hook: safari-preview-affected-tests) wpt.fyi hook: safari-preview-affected-tests succeeded
Details
@azure-pipelines
Azure Pipelines (wpt.fyi hook: safari-preview-affected-tests-without-changes) wpt.fyi hook: safari-preview-affected-tests-without-changes succeeded
Details
@community-tc-integration
download-firefox-nightly Community-TC (pull_request)
Details
@community-tc-integration
infrastructure/ tests Community-TC (pull_request)
Details
@community-tc-integration
lint Community-TC (pull_request)
Details
@community-tc-integration
resources/ tests (Python 3.6) Community-TC (pull_request)
Details
@community-tc-integration
resources/ tests (Python 3.9) Community-TC (pull_request)
Details
@community-tc-integration
sink-task Community-TC (pull_request)
Details
@community-tc-integration
tools/ integration tests (Python 3.6) Community-TC (pull_request)
Details
@community-tc-integration
tools/ integration tests (Python 3.9) Community-TC (pull_request)
Details
@community-tc-integration
tools/ unittests (Python 3.6) Community-TC (pull_request)
Details
@community-tc-integration
tools/ unittests (Python 3.9) Community-TC (pull_request)
Details
@community-tc-integration
update-built Community-TC (pull_request)
Details
@community-tc-integration
wpt-chrome-dev-results Community-TC (pull_request)
Details
@community-tc-integration
wpt-chrome-dev-results-without-changes Community-TC (pull_request)
Details
@community-tc-integration
wpt-chrome-dev-stability Community-TC (pull_request)
Details
@community-tc-integration
wpt-decision-task Community-TC (pull_request)
Details
@community-tc-integration
wpt-firefox-nightly-results Community-TC (pull_request)
Details
@community-tc-integration
wpt-firefox-nightly-results-without-changes Community-TC (pull_request)
Details
@community-tc-integration
wpt-firefox-nightly-stability Community-TC (pull_request)
Details
@wpt-fyi
wpt.fyi - chrome[experimental] Chrome results
Details
@wpt-fyi
wpt.fyi - firefox[experimental] Firefox results
Details
@wpt-fyi
wpt.fyi - safari[experimental] Safari results
Details
@foolip foolip deleted the foolip/rm-wptrunner-usage branch May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants