Skip to content

doc: add examples#13

Merged
ElouenGinat merged 35 commits into
mainfrom
doc
Jun 19, 2026
Merged

doc: add examples#13
ElouenGinat merged 35 commits into
mainfrom
doc

Conversation

@ElouenGinat

Copy link
Copy Markdown
Collaborator

No description provided.

- Updated index.rst to include a new Guides section with links to API Comparison and Demo.
- Created a new documentation file for the  function in khisto.matplotlib.
- Removed the outdated requirements.txt file and migrated dependencies to the pyproject.toml under a new 'docs' section for better management.
@ElouenGinat ElouenGinat self-assigned this Apr 17, 2026

@marcboulle marcboulle left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remarques minimalistes

Je ferai plutôt une relecture approfondie de la doc en mode utilisateur lors de la béta.

Comment thread docs/api_comparison.rst
Comment thread docs/api_comparison.rst Outdated
@ElouenGinat
ElouenGinat requested a review from popescu-v April 17, 2026 15:15
- Updated index.rst to include a new Guides section with links to API Comparison and Demo.
- Created a new documentation file for the  function in khisto.matplotlib.
- Removed the outdated requirements.txt file and migrated dependencies to the pyproject.toml under a new 'docs' section for better management.
- Updated the main index.rst to provide a clearer introduction to Khisto, highlighting its adaptive binning capabilities and various entry points for users.
- Added a description in matplotlib/index.rst to explain the use of khisto.matplotlib.hist for adaptive histogramming, emphasizing its convenience compared to traditional plt.hist.
Made dependency management better. clarified param x for hist api.
fix: enforce 1-D input requirement for histogram functions and update tests
@ElouenGinat
ElouenGinat requested a review from marcboulle April 24, 2026 08:35

@marcboulle marcboulle left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Les points essentiels sont résolus: je ferais la relecture détaillée finale lors de la phase de bêta-test.

Comment thread src/khisto/core/backend.py
Comment thread src/khisto/core/backend.py Outdated
Comment thread src/khisto/core/backend.py Outdated
Comment thread src/khisto/core/backend.py Outdated
Comment thread src/khisto/core/backend.py Outdated
Comment thread src/khisto/core/backend.py Outdated
Comment thread src/khisto/core/backend.py Outdated
Comment thread src/khisto/core/backend.py Outdated
Comment thread src/khisto/core/backend.py Outdated
Comment thread .github/workflows/docs.yaml Outdated
Comment thread docs/api_comparison.rst Outdated
Comment thread docs/conf.py
Comment thread src/khisto/matplotlib/hist.py

@popescu-v popescu-v left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Several comments.
General remarks:

  • use PEP 8 naming conventions systematically;
  • systematically check input parameter types on public APIs.

Comment thread src/khisto/core/backend.py Outdated
Comment thread src/khisto/core/backend.py Outdated
- Updated index.rst to include a new Guides section with links to API Comparison and Demo.
- Created a new documentation file for the  function in khisto.matplotlib.
- Removed the outdated requirements.txt file and migrated dependencies to the pyproject.toml under a new 'docs' section for better management.
- Updated the main index.rst to provide a clearer introduction to Khisto, highlighting its adaptive binning capabilities and various entry points for users.
- Added a description in matplotlib/index.rst to explain the use of khisto.matplotlib.hist for adaptive histogramming, emphasizing its convenience compared to traditional plt.hist.
Made dependency management better. clarified param x for hist api.
fix: enforce 1-D input requirement for histogram functions and update tests
Comment thread src/khisto/core/backend.py Outdated

@popescu-v popescu-v left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, modulo the typing issues (to address in a subsequent PR).

@ElouenGinat
ElouenGinat merged commit e2f5418 into main Jun 19, 2026
17 checks passed
@ElouenGinat
ElouenGinat deleted the doc branch June 19, 2026 15:03
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 this pull request may close these issues.

3 participants