Updates docs: fields => fields_csv and tables => tables_csv #77
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
The docs list the arguments on `flatterer.flatten` as `fields` and `tables` for "Python Usage." However, when used, they result in `TypeError: flatten() got an unexpected keyword argument 'fields'` and `TypeError: flatten() got an unexpected keyword argument 'tables'`. As can be seen at [flatterer/__init__.py#73](https://github.com/kindly/flatterer/blob/b6c47fb6882f574d2a664d94ca3128784cb454fe/flatterer/__init__.py#L73) and [flatterer/__init__.py#75](https://github.com/kindly/flatterer/blob/b6c47fb6882f574d2a664d94ca3128784cb454fe/flatterer/__init__.py#L75), the arguments are actually `fields_csv` and `tables_csv` respectively. This change updates the documentation to reflect the correct argument names. Note that the arguments for `flatterer.cli` are `fields` and tables`. But that function is not documented for Python usage.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The docs list the arguments on
flatterer.flattenasfieldsandtablesfor "Python Usage." However, when used, they result inTypeError: flatten() got an unexpected keyword argument 'fields'andTypeError: flatten() got an unexpected keyword argument 'tables'. As can be seen at flatterer/__init__.py#73 and flatterer/__init__.py#75, the arguments are actuallyfields_csvandtables_csvrespectively. This change updates the documentation to reflect the correct argument names.Note that the arguments for
flatterer.cliarefieldsandtables. But that function is not documented for Python usage.