Add Module Docstrings #25
Merged
Conversation
This file contains hidden or 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
ToluClassics
changed the title
kitsamho
reviewed
Jun 1, 2023
skllm/models/gpt_zero_shot_clf.py
Outdated
| openai_key : str, optional | ||
| The OPEN AI key to use. Defaults to None. | ||
| openai_org : str, optional | ||
| The OPEN AI organization to use. Defaults to None. |
There was a problem hiding this comment.
I would change this to The OPEN AI organization ID
Contributor
Author
There was a problem hiding this comment.
I see, that's still a string right?
There was a problem hiding this comment.
Yeah, it's just a good reminder to use the string ID rather than the name
iryna-kondr
reviewed
Jun 4, 2023
iryna-kondr
reviewed
Jun 4, 2023
iryna-kondr
reviewed
Jun 4, 2023
iryna-kondr
reviewed
Jun 4, 2023
iryna-kondr
requested changes
Jun 4, 2023
Collaborator
iryna-kondr
left a comment
iryna-kondr
left a comment
There was a problem hiding this comment.
In addition to the mentioned comments, could you please adjusts most of the docstrings such that they are written in the third person, singular form (e.g. "Fits the model")?
OKUA1
approved these changes
Jun 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
No description provided.