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: review of the @see tags #532

Merged
merged 4 commits into from
Sep 17, 2021

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Sep 17, 2021

Pull Request Type

  • I have checked there is no other PR open for the same change.

This is a:

  • Bug fix
  • New feature
  • Code quality improvement

Context

Improving the generated documentation for the website.

Detailed Description

Docs: use @link tags for external references

Docs: use parentheses when referencing a function in a @see tag

Docs: use fully qualified names in @see tags [1]

... for Requests native classes to prevent confusion.

Docs: use fully qualified names in @see tags [2]

... for external (PHP native) classes.

Previously, APIGen would add an incorrect link for this reference, which had to be removed for each website update.
With this change, that manual update can now hopefully be prevented.

Quality assurance

  • This change does NOT contain a breaking change (fix or feature that would cause existing functionality to change).
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added unit tests to accompany this PR.
  • The (new/existing) tests cover this PR 100%.
  • I have (manually) tested this code to the best of my abilities.
  • My code follows the style guidelines of this project.

Documentation

For new features:

  • I have added a code example showing how to use this feature to the examples directory.
  • I have added documentation about this feature to the docs directory.
    If the documentation is in a new markdown file, I have added a link to this new file to the Docs folder README.md file.

... for Requests native classes to prevent confusion.
... for external (PHP native) classes.

Previously, APIGen would add an incorrect link for this reference, which had to be removed for each website update.
With this change, that manual update can now hopefully be prevented.
@schlessera schlessera merged commit 1c1b1f3 into develop Sep 17, 2021
@schlessera schlessera deleted the feature/docs-review-of-see-tags branch September 17, 2021 09:44
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.

2 participants