Completes UNB-2832 - Clearly indicate which args are optional in the … #56
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
whoseoyster reviewed Sep 2, 2022
| language: str = "en", | ||
| sep: str = ",", | ||
| commit_message: Optional[str] = None, | ||
| language: Optional[str] = "en", |
There was a problem hiding this comment.
this typing is wrong. If it's not specified, it defaults to "en", which is a string.
| label_column_name: str, | ||
| feature_names: List[str] = [], | ||
| text_column_name: Optional[str] = None, | ||
| text_column_name: str = None, |
There was a problem hiding this comment.
why did you remove the Optional? It defaults to None
| ---------- | ||
| file_path : str | ||
| Path to the csv file containing the dataset. | ||
| commit_message : str, default None |
There was a problem hiding this comment.
why did you move this up here? The order in here needs to match the order of the args
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.
…API reference
Summary
Updated API reference according to Jason's feedback. He'd like to more clearly see which args are optional and which aren't.
optionalnext to the arg type and before the default value, following the ordering thatpandasuses (e.g. here)commit_messagetowards the top of the docstring, to make it more evident