-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Google doc strings #3164
Merged
Merged
Google doc strings #3164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
helpmefindaname
force-pushed
the
google-doc-strings
branch
from
April 17, 2023 15:51
7c6db35
to
848bf27
Compare
alanakbik
approved these changes
Apr 19, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @helpmefindaname this looks really good!
Lazydocs throws some errors, but mostly in the test classes:
Failed to generate docs for module flair.models.regexp_tagger: AttributeError("module 'flair.models.regexp_tagger' has no attribute '__create_fn__'")
Failed to generate docs for module tests.embeddings.test_document_transform_word_embeddings: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.embeddings.test_tfidf_embeddings: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.model_test_utils: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.models.test_entity_linker: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.models.test_relation_classifier: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.models.test_relation_extractor: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.models.test_sequence_tagger: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.models.test_tars_classifier: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.models.test_tars_ner: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.models.test_text_classifier: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.models.test_text_regressor: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.models.test_word_tagger: TypeError('super(type, obj): obj must be an instance or subtype of type')
Failed to generate docs for module tests.test_trainer: TypeError('super(type, obj): obj must be an instance or subtype of type')
But I think this is something for a future PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use flake8-pydocstrings to enforce that existing doc strings follow the google docs format. And fix the format wherever it is not correctly following the google doc string format.
Current todo list: