Skip to content

Docblocks: update all @package tags#606

Merged
schlessera merged 1 commit intodevelopfrom
feature/590-docs-package-tag-review
Nov 8, 2021
Merged

Docblocks: update all @package tags#606
schlessera merged 1 commit intodevelopfrom
feature/590-docs-package-tag-review

Conversation

@jrfnl
Copy link
Copy Markdown
Member

@jrfnl jrfnl commented Nov 8, 2021

This commit:

  • Removes all @subpackage tags in favour of hierarchical @package tags.
  • Adds the missing docblocks to the Transport exception classes.
  • Changes the tags for the HookManager interface and the Hooks class from Requests\Utilities to Requests\EventDispatcher.
  • Changes the package for all exception classes to Requests\Exceptions.

Includes minor tag grouping and alignment tweaks.

Fixes #590

This commit:
* Removes all `@subpackage` tags in favour of hierarchical `@package` tags.
* Adds the missing docblocks to the Transport exception classes.
* Changes the tags for the `HookManager` interface and the `Hooks` class from `Requests\Utilities` to `Requests\EventDispatcher`.
* Changes the package for all exception classes to `Requests\Exceptions`.

Includes minor tag grouping and alignment tweaks.

Fixes 590
@jrfnl jrfnl added this to the 2.0.0 milestone Nov 8, 2021
@jrfnl jrfnl requested a review from schlessera November 8, 2021 10:19
@schlessera schlessera merged commit 5d99f54 into develop Nov 8, 2021
@schlessera schlessera deleted the feature/590-docs-package-tag-review branch November 8, 2021 10:34
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.

Generated documentation - package tag or no package tag ?

2 participants