Code

Update metadata docstrings#368

Code

Merged

gviejo merged 32 commits intodevpynapple-org/pynapple:devfrom metadatapynapple-org/pynapple:metadataCopy head branch name to clipboardNov 22, 2024

+1,289-338

Commits

Commits on Nov 14, 2024

• update docstrings in metadata_class.py and add more examples in set_info and get_info. allow getting with metadata index when index is string (for TsdFrame)

  sjvenditto

  committed
  2904388

Commits on Nov 15, 2024

• added more examples to get_info and set_info and tested with doctest. added initialization examples to intervalset

  sjvenditto

  committed
  f6c4ed3

• TsdFrame init examples

  sjvenditto

  committed
  cef458d

• docstring examples for tsgroup init

  sjvenditto

  committed
  293a9d6

• reorganize ts_group docstring, add docstrings for attributed without their own def

  sjvenditto

  committed
  35d8a11

Commits on Nov 18, 2024

• first pass on metadata core methods for docs

  sjvenditto

  committed
  458b22b

Commits on Nov 19, 2024

• isort

  sjvenditto

  committed
  df7e7f2

• move init docs of intervalset and tsdframe. add some property docstrings

  sjvenditto

  committed
  6793901

• collapse module in doc names

  sjvenditto

  committed
  1602339

• updates to core methods page

  sjvenditto

  committed
  1425499

• rearrange core methods sections, update metadata initialization examples

  sjvenditto

  committed
  7943bc3

• Update 04_core_methods.md

  Show description for 5bde477
  sjvenditto

  committed
  5bde477

Commits on Nov 20, 2024

• fix HD tutorial

  sjvenditto

  committed
  39b4d05

• smallc hanges

  gviejo

  committed
  fd24a86

• remove redundant init docstrings

  sjvenditto

  committed
  16de010

• Merge branch 'metadata' of https://github.com/pynapple-org/pynapple into metadata

  sjvenditto

  committed
  8c1ba66

Commits on Nov 21, 2024

• decorator for adding metadata doc strings to allow for class-specific examples

  sjvenditto

  committed
  a548b7d

• intervalset set_info examples

  sjvenditto

  committed
  881bcbe

• set_info examples for TsdFrame

  sjvenditto

  committed
  565e8d8

• move get_info examples to tsgroup

  sjvenditto

  committed
  3ca8672

• get_info examples for intervalset

  sjvenditto

  committed
  b11227e

• get_info examples for tsdframe

  sjvenditto

  committed
  7bd540a

• Update ts_group.py

  sjvenditto

  committed
  581df5b

• update core methods

  sjvenditto

  committed
  8d2de11

• override docs directly instead of methods to make tests happy

  sjvenditto

  committed
  8160b8d

• Update 04_core_methods.md

  sjvenditto

  committed
  4e5280b

• remove decorator

  sjvenditto

  committed
  ea137b7

• Revert "remove decorator"

  Show description for 02f0739
  sjvenditto

  committed
  02f0739

• Revert "override docs directly instead of methods to make tests happy"

  Show description for 54b4c6c
  sjvenditto

  committed
  54b4c6c

• revert to overriding functions and update test to make docs happy

  sjvenditto

  committed
  13f6df6

• Update test_metadata.py

  sjvenditto

  committed
  3fb02dc

Commits on Nov 22, 2024

• Fixing a few typos

  gviejo

  committed
  86ca812