Skip to content

[docs] Correct minor problems#17751

Merged
jugglinmike merged 5 commits into
web-platform-tests:masterfrom
bocoup:docs-misc
Jul 24, 2019
Merged

[docs] Correct minor problems#17751
jugglinmike merged 5 commits into
web-platform-tests:masterfrom
bocoup:docs-misc

Conversation

@jugglinmike
Copy link
Copy Markdown
Contributor

These changes aren't strongly related to each other, but submitting separate
pull requests seemed a little too process-heavy. That said, I'm happy to split
this apart if any specific changes warrant a dedicated discussion.

Comment thread docs/writing-tests/general-guidelines.md Outdated
filler text.

Obviously, none of this can be taken as absolute rules, as testing of
None of these rules are absolute because testing
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
None of these rules are absolute because testing
None of these rules are absolute, because testing

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This looks like a stylistic usage rather than one that clarifies meaning. I'd prefer to omit it unless you have a more objective rational.

Previously, the description of test file formats was incomplete and
somewhat confusingly-worded. Expand the explanation to fully describe
the accepted formats, and include additional advice for how to learn
more in context.
This section is also included in the "General Guidelines" document which
describes expecations for all tests, including "rendering tests."
The word "obviously" may discourage readers for whom the following
statement was not obvious. Remove it and simplify the sentence
structure.
@jugglinmike
Copy link
Copy Markdown
Contributor Author

gh-17797 introduced a trivial conflict for this change set. I've rebased and force-pushed the result to this branch. The original version of this branch is available here:

master...bocoup:docs-misc-orig

I'm going to merge this myself.

@jugglinmike jugglinmike merged commit e31ca03 into web-platform-tests:master Jul 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants