[DOC] - Update API list

neurodsp-tools / neurodsp

Digital signal processing for neural time series.

https://neurodsp-tools.github.io/

Apache License 2.0

281 stars 61 forks source link

[DOC] - Update API list #281

Closed TomDonoghue closed 2 years ago

TomDonoghue commented 2 years ago

This updates to API list to include some new functions that have recently been added.

It also:

reorganizes the API list for the aperiodic sub-module
adds an explicit listing of relevant utility functions

TomDonoghue commented 2 years ago

Re the API / init check (@ryanhammonds) that's a great idea to check that. I don't think I've ever had a super consistent way to deciding what gets linked in inits, but I think that considering that anything listed in the public API is worth adding in inits for easier / quicker imports is a good guideline to follow!

Updates LGTM - merging this in now!