Skip to content

Commit

Permalink
Steph feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
h-mayorquin committed Dec 19, 2024
1 parent 536b644 commit 598580e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
1 change: 0 additions & 1 deletion docs/best_practices/nwbfile_metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ best guess. If the exact start time is unknown, then it is fine to simply set it

Check functions: :py:meth:`~nwbinspector.checks._nwbfile_metadata.check_session_start_time_old_date`,
:py:meth:`~nwbinspector.checks._nwbfile_metadata.check_session_start_time_future_date`,
:py:meth:`~nwbinspector.checks._time_series.check_timestamp_of_the_first_sample_is_not_negative`
:py:meth:`~nwbinspector.checks._tables.check_table_time_columns_are_not_negative`


Expand Down
10 changes: 5 additions & 5 deletions docs/best_practices/time_series.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,17 +130,17 @@ Avoid Negative Timestamps

When writing :ref:`nwb-schema:sec-TimeSeries` data, avoid using negative timestamps.

All timestamps in the NWBFile are written with respect to a global reference point (either ``timestamps_reference_time`` or ``session_start_time``).
All timestamps in the NWBFile are written with respect to a global reference point (either ``timestamps_reference_time`` or ``session_start_time``).

While negative timestamps are technically valid, they might introduce unnecessary complications for future users of the file. In most cases, negative timestamps may be indicative of an alignment error or a problem with the source data. As much as possible, re-align the session start time so that all timestamps are positive and correctly referenced to either ``timestamps_reference_time`` or ``session_start_time``.
While negative timestamps are technically valid, they might introduce unnecessary complications for future users of the file.
In most cases, negative timestamps may be indicative of an alignment error or a problem with the source data.
As much as possible, re-align the session start time so that all timestamps are positive and correctly referenced to either ``timestamps_reference_time`` or ``session_start_time``.
See :ref:`best_practice_global_time_reference` for more details.

Check function: :py:meth:`~nwbinspector.checks._time_series.check_timestamp_of_the_first_sample_is_not_negative`

.. _best_practice_chunk_data:

.. _best_practice_chunk_data:


Chunk Data
~~~~~~~~~~

Expand Down

0 comments on commit 598580e

Please sign in to comment.