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

Minor docstring inaccuracies #75

Closed
Seth-Rothschild opened this issue Jan 23, 2018 · 1 comment · Fixed by #77
Closed

Minor docstring inaccuracies #75

Seth-Rothschild opened this issue Jan 23, 2018 · 1 comment · Fixed by #77
Assignees

Comments

@Seth-Rothschild
Copy link
Contributor

I came accross these two issues:

  1. In entity_from_dataframe it says secondary_time_index is a string, when it should be a dictionary.
  2. In normalize_entity there's an undocumented kwarg variable_types.
    I'm thinking of using the branch to fix them to also standardize the notation in those two docstrings for lists, dicts and optional arguments to
list[str]
(dict[str->list[str]], optional)
@Seth-Rothschild Seth-Rothschild self-assigned this Jan 23, 2018
@Seth-Rothschild
Copy link
Contributor Author

It's worth noting that other pages follow slightly different styles as well. make_agg_primitive uses distinct, possibly better notation which states list[Variable] with special typesetting for Variable to indicate it's a featuretools class. Maybe it's better to spec to that and try to standardize all of the long docstrings at once?

I'm thinking:

  1. entity_fromdataframe`
  2. normalize_entity
  3. make_agg_primitive and make_trans_primitive
  4. dfs
  5. calculate_feature_matrix

Am I missing any other big ones?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant