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

Docs: various minor updates #309

Merged
merged 4 commits into from
Apr 19, 2022
Merged

Docs: various minor updates #309

merged 4 commits into from
Apr 19, 2022

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Apr 18, 2022

PassedParameters: improve/simplify documentation about supported constructs

Docs: various grammar and punctuation fixes

Docs: update info on PHPCS

... in various places.

  • Ensure that BCFile changelog is complete and references the correct version numbers.
  • Ensure that inline comments contain sufficient information about what PHPCS version is involved.

Docs/Collections: various tweaks

  • For those properties which have been deprecated, make sure the @since tag lists the alpha version in which the property was added.
  • For self-references in inline @see tags, no need to use FQNs.
  • Add various additional @see tags for inter-function/property references.

... in various places.

* Ensure that BCFile changelog is complete and references the correct version numbers.
* Ensure that inline comments contain sufficient information about what PHPCS version is involved.
* For those properties which have been deprecated, make sure the `@since` tag lists the `alpha` version in which the property was added.
* For self-references in inline `@see` tags, no need to use FQNs.
* Add various additional `@see` tags for inter-function/property references.
@jrfnl jrfnl added this to the 1.0.0-alpha4 milestone Apr 18, 2022
@jrfnl jrfnl enabled auto-merge April 18, 2022 23:58
@jrfnl jrfnl disabled auto-merge April 19, 2022 00:25
@jrfnl jrfnl merged commit 842f3e2 into develop Apr 19, 2022
@jrfnl jrfnl deleted the feature/minor-docs-updates branch April 19, 2022 00:25
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.

None yet

1 participant