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

Type documentation fixes for Doc #13187

Merged
merged 7 commits into from
Dec 18, 2023
Merged

Conversation

svlandeg
Copy link
Member

@svlandeg svlandeg commented Dec 7, 2023

Description

  • Fix doc.pyi to include the fact that char_span() can return None
  • Unify type documentation of exclude: it's a tuple by default, originally documented to be a List. Can be documented as an Iterable[str], like we do for util.to_dict and the to_disk method in doc.pyi.

Types of change

docs fixes

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 added docs Documentation and website feat / doc Feature: Doc, Span and Token objects labels Dec 7, 2023
spacy/tokens/doc.pyx Outdated Show resolved Hide resolved
spacy/tokens/doc.pyi Outdated Show resolved Hide resolved
@adrianeboyd adrianeboyd merged commit 56fc3bc into explosion:master Dec 18, 2023
13 checks passed
@svlandeg svlandeg deleted the fix/types branch January 25, 2024 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation and website feat / doc Feature: Doc, Span and Token objects
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants