Skip to content

Updating docs for explain.py #128

Description

@chrislangreo

Overview

Updating documentation for explain.py:

  • Adding more examples in Explain.ipynb
  • Updating explain.md with changes to explain.py. Mostly related to the addition of prefixes to columns that get added to the returned DataFrame when using a function from explain.py. As of this writing, explain.py has explain functions for command line commands and events. The columns that get added from these commands have overlapping column names (e.g. explanation). In the event that a user pipes these two commands in succession (e.g. df.pipe(command_line_explain...).pipe(event_explain...)), it would be a bit ambiguous as to which explanation relates to which one. Therefore, a prefix was added.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions