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

Fix tutorial error and update API reference #334

Merged
merged 3 commits into from
Jun 19, 2024

Conversation

ZergLev
Copy link
Collaborator

@ZergLev ZergLev commented Mar 3, 2024

Description

Minor fix and updates to 'Tutorials' and 'API reference'.

  • 'API reference' claimed "wrappers" are a parameter of both classes Pipeline() and Service(), but instead there are "before_handler" and "after_handler", now updated.
  • For the above reason, replaced term "wrapper" with "extra handler" where appropriate within both tutorials and docs. (user guides required no changes)
  • Similarly and for the same reasons, references of "services" from class Pipeline() changed to "components" both within docs and tutorials. (user guides required no changes)
  • In tutorial Script/Core:4.Transitions comments had wrong order of transitions, now fixed.

Checklist

  • I have performed a self-review of the changes

To Consider

  • In dff/stats/utils.py there is a function called get_wrapper_field(), but wrappers were changed to extra handlers, I think. Is this intended?
  • Currently, there are no explanations or links to API within the tutorials as to what ExtraHandlerBuilder and ExtraHandlerFunction objects are.
  • Search for references to changed entities in the API reference/tutorials/guides

@ZergLev ZergLev closed this Mar 3, 2024
@ZergLev ZergLev reopened this Mar 3, 2024
@RLKRo RLKRo added the documentation Improvements or additions to documentation label Mar 5, 2024
@RLKRo RLKRo merged commit b5ed32e into deeppavlov:dev Jun 19, 2024
12 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants