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.

Sign up for GitHub

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

Jump to bottom

Signature docs error in API docs for MorphAnalysis.__contains__ #13406

Closed
schorfma opened this issue Apr 2, 2024 · 2 comments · Fixed by #13433
Closed

Signature docs error in API docs for MorphAnalysis.__contains__ #13406

schorfma opened this issue Apr 2, 2024 · 2 comments · Fixed by #13433
Labels
docs Documentation and website

Comments

@schorfma
Copy link

schorfma commented Apr 2, 2024

Hello spaCy team,

I encountered another small error in the API docs.

For the method MorphAnalysis.__contains__ in the API docs, the description for the return value actually describes the method argument, which is missing.

| Name        | Description                                   |
| ----------- | --------------------------------------------- |
| **RETURNS** | A feature/value pair in the analysis. ~~str~~ |

Suggested Changes

- | Name        | Description                                   |
- | ----------- | --------------------------------------------- |
- | **RETURNS** | A feature/value pair in the analysis. ~~str~~ |

+ | Name         | Description                                                           |
+ | ------------ | --------------------------------------------------------------------- |
+ | `feature`    | A feature/value pair. ~~str~~                                         |
+ | **RETURNS**  | Whether the feature/value pair is contained in the analysis. ~~bool~~ |

Which page or section is this issue related to?
@svlandeg svlandeg added the docs Documentation and website label Apr 4, 2024
@svlandeg svlandeg mentioned this issue Apr 11, 2024
Merged
3 tasks
@svlandeg
Copy link
Member

Thanks for the report! Your fix looks correct and I contributed it as #13433 (feel free to open a PR directly for these kind of fixes!)

@schorfma
Copy link
Author

Thanks for the report! Your fix looks correct and I contributed it as #13433 (feel free to open a PR directly for these kind of fixes!)

Thank you.

Then, I will prepare a combined pull request for #13405 and additional typos I stumbled upon (For the latter I did not open issues).

Greetings
Martin

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation and website
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix docs for MorphAnalysis.__contains__ svlandeg/spaCy
2 participants
@svlandeg @schorfma