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

remove pdf documentation #412

Merged
merged 17 commits into from
Nov 6, 2024

Conversation

AurelienJaquier
Copy link
Collaborator

@AurelienJaquier AurelienJaquier commented Oct 4, 2024

Description

There was no substantial information in the pdf that were not already present in the official doc. The official doc was based on the pdf I believe, so many things were similar. But since the doc has been kept up to date, it is actually more detailed than the pdf, exception to the algorithm descriptions.

Also did:

  • added tests for python 3.13 (did not add wheels yet because it is difficult to make them work, will do in another PR)
  • added an example for using settings, and added this example to the docs
  • added a limit to mypy version (latest version is buggy) - to remove once mypy works as expected again
  • added to features docs:
    • check_ais_initiation
    • bpap_attenuation
    • peak_indices
    • AP_rise_indices
    • AP_end_indices
    • AP_fall_indices
    • min_AHP_indices
    • AP_begin_indices
    • min_between_peaks_indices
    • burst_begin_indices
    • burst_end_indices
    • ADP_peak_indices
    • interburst_min_indices
    • postburst_min_indices
    • postburst_slow_ahp_indices
    • postburst_fast_ahp_indices
    • postburst_adp_peak_indices
    • interburst_15percent_indices
    • interburst_20percent_indices
    • interburst_25percent_indices
    • interburst_30percent_indices
    • interburst_40percent_indices
    • interburst_60percent_indices
    • burst_ISI_indices

Checklist:

  • Unit tests are added to cover the changes (skip if not applicable).
  • The changes are mentioned in the documentation (skip if not applicable).
  • CHANGELOG file is updated (skip if not applicable).

@codecov-commenter
Copy link

codecov-commenter commented Oct 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.51%. Comparing base (2cddd26) to head (b3f656b).
Report is 34 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #412      +/-   ##
==========================================
- Coverage   91.73%   91.51%   -0.22%     
==========================================
  Files          36       39       +3     
  Lines        6278     7744    +1466     
  Branches     2033     2366     +333     
==========================================
+ Hits         5759     7087    +1328     
- Misses        266      316      +50     
- Partials      253      341      +88     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@darshanmandge darshanmandge left a comment

Choose a reason for hiding this comment

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

Thanks @AurelienJaquier ! Could you also update the PR description and Changelog to mention all the indices features added?:

added to features docs: check_ais_initiation, bpap_attenuation, all indices features

Users might misunderstand that the "all indices features" is one efel feature :)

examples/settings/settings_notebook.ipynb Outdated Show resolved Hide resolved
Copy link
Contributor

@darshanmandge darshanmandge left a comment

Choose a reason for hiding this comment

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

👍

@AurelienJaquier AurelienJaquier merged commit 21d828b into BlueBrain:master Nov 6, 2024
21 checks passed
@AurelienJaquier AurelienJaquier deleted the remove-pdf branch November 6, 2024 14:33
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