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

Correct API docs for Span.lemma_, Vocab.to_bytes and Vectors.__init__ #13436

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

schorfma
Copy link

@schorfma schorfma commented Apr 12, 2024

Description

This pull request combines three small changes to the API docs to fix errors, I have stumbled upon while carefully reading on the API details.

Types of change

This correction for the API docs addresses:

  1. Wrong code example for the property Span.lemma_ (First reported in Code example discrepancy for Span.lemma_ in API docs #13405, Addressed in commit b334a7a)
  2. Wrong return type (Vocab instead of bytes) for the method Vocab.to_bytes (Addressed in commit ce88925)
  3. Slightly incorrect wording (Sequence instead of Iterable) in constructor method Vectors.__init__ (Addressed in commit d9c368d)

Checklist

  • I confirm that I have the right to submit this contribution under the project's MIT license.
  • I ran the tests, and all new and existing tests passed.
  • My changes don't require a change to the documentation, or if they do, I've added all required information.

@svlandeg svlandeg linked an issue Apr 15, 2024 that may be closed by this pull request
@svlandeg svlandeg added the docs Documentation and website label Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation and website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Code example discrepancy for Span.lemma_ in API docs
2 participants