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

Documentation: minor consistency fixes #572

Merged
merged 8 commits into from
Jul 23, 2024

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Jul 22, 2024

Description

Generic/Documentation: minor consistency fixes

  • Verified that the contents of <standard> elements is consistently indented (with four spaces).
  • Verified that all <code> title attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".

PEAR/Documentation: minor consistency fixes

  • Verified that the contents of <standard> elements is consistently indented (with four spaces).
  • Verified that all <code> title attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".

Docs/PEAR//FileComment: fix up swapped valid/invalid blocks

The invalid block for the "tag order" was next to the "valid" PHP version code sample and visa versa.

Docs/PEAR//FileComment: fix readability of the standard

Before

image

After

image

PSR1/2/12/Documentation: minor consistency fixes

  • Verified that the contents of <standard> elements is consistently indented (with four spaces).
  • Verified that all <code> title attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".

Squiz/Documentation: minor consistency fixes

  • Verified that the contents of <standard> elements is consistently indented (with four spaces).
  • Verified that all <code> title attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".

Squiz/FunctionDuplicateArgument: remove incorrect documentation

Looks like this XML file was committed/accepted by accident / was an unfinished copy/paste error, as it has nothing to do with the Squiz.Functions.FunctionDuplicateArgument sniff.

The sniff should be properly documented and the sniff has now been added to the task list in #148

Zend/Documentation: minor consistency fixes

  • Verified that the contents of <standard> elements is consistently indented (with four spaces).
  • Verified that all <code> title attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".

Suggested changelog entry

N/A

Related issues/external references

Loosely related to #148

Types of changes

  • Documentation improvement

jrfnl added 8 commits July 22, 2024 19:30
* Verified that the contents of `<standard>` elements is consistently indented (with four spaces).
* Verified that all `<code>` `title` attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".
* Verified that the contents of `<standard>` elements is consistently indented (with four spaces).
* Verified that all `<code>` `title` attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".
The `invalid` block for the "tag order" was next to the "valid" PHP version code sample and visa versa.
* Verified that the contents of `<standard>` elements is consistently indented (with four spaces).
* Verified that all `<code>` `title` attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".
* Verified that the contents of `<standard>` elements is consistently indented (with four spaces).
* Verified that all `<code>` `title` attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".
Looks like this XML file was committed/accepted by accident / was an unfinished copy/paste error, as it has nothing to do with the `Squiz.Functions.FunctionDuplicateArgument` sniff.

The sniff should be propely documented and the sniff has now been added to the task list in 148
* Verified that the contents of `<standard>` elements is consistently indented (with four spaces).
* Verified that all `<code>` `title` attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".
@jrfnl jrfnl added this to the 3.10.x Next milestone Jul 22, 2024
@jrfnl jrfnl changed the title Feature/docs minor consistency fixes Documentation: minor consistency fixes Jul 22, 2024
@jrfnl jrfnl merged commit 329ad21 into master Jul 23, 2024
49 checks passed
@jrfnl jrfnl deleted the feature/docs-minor-consistency-fixes branch July 23, 2024 06:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant