matnwb icon indicating copy to clipboard operation
matnwb copied to clipboard

Documentation: Update intro tutorial

Open ehennestad opened this issue 3 months ago • 1 comments

Fix #672

Depends on

  • ~~#730~~

Motivation

Simplify introduction tutorial and make it follow a story line instead of demonstrating the use of types in a more disconnected manner.

PR Changes

  • General updating of structure to follow imaginary experiment
  • Update class diagrams to reflect MatNWB property names
  • Fix issue 672 - added all neurodata types to the file
  • Removed Class diagram in Trials section. It is not discussed and too advanced for intro tutorial?

How to test the behavior?

Show here how to reproduce the new behavior (can be a bug fix or a new feature)

Checklist

  • [x] Have you ensured the PR description clearly describes the problem and solutions?
  • [x] Have you checked to ensure that there aren't other open or previously closed Pull Requests for the same change?
  • [x] If this PR fixes an issue, is the first line of the PR description fix #XX where XX is the issue number?

ehennestad avatar Sep 02 '25 18:09 ehennestad

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 95.59%. Comparing base (6cb513a) to head (6040b78).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #749   +/-   ##
=======================================
  Coverage   95.59%   95.59%           
=======================================
  Files         184      184           
  Lines        6443     6443           
=======================================
  Hits         6159     6159           
  Misses        284      284           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Sep 02 '25 20:09 codecov[bot]