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

ProfileReport docstring #1524

Open
MarcNuebel opened this issue Jan 7, 2024 · 0 comments
Open

ProfileReport docstring #1524

MarcNuebel opened this issue Jan 7, 2024 · 0 comments

Comments

@MarcNuebel
Copy link

Missing functionality

Docstring of the init function of ProfileReport is incomplete/incorrect

  • ts_mode has a different name
  • sort_by has a different name
  • explorative is not explained
  • dark_mode is not explained
  • orange_mode is not explained
  • sample is in the wrong order
  • config is not explained

Proposed feature

Repair docstring of this user-facing class.

My understanding of what it does:

  • explorative: sets memory_deep to true
  • dark_mode: use black color theme for report header and text. Mutually exclusive with orange_mode. Background stays white
  • orange_mode: use orange color theme for report header and text. Mutually exclusive with dark_mode
  • config: optional alternative to config_file to set Settings object directly

I am unsure what else "explorative" does. Most of the things it sets seem to be the same as the default.
Open to do a PR.

Alternatives considered

No response

Additional context

No response

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

No branches or pull requests

2 participants