Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
CBroz1 committed Oct 4, 2023
1 parent 5d5e3d6 commit 67e7014
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
13 changes: 6 additions & 7 deletions docs/src/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Notes on how the repo / database is organized, intended for a new developer.
- These are tables that are part of many pipelines.
- Examples: `IntervalList` (whose entries define time interval for any
analysis), `AnalysisNwbfile` (whose entries define analysis NWB files created
for any analysis), `Sortings` (whose entries include many types of spike
for any analysis), `SpikeSorting` (whose entries include many types of spike
sorting, such as uncurated, automatically curated, manually curated etc)
- Data tier: `dj.Manual`
- Note that because these are stand-alone manual tables, they are not part of
Expand Down Expand Up @@ -137,7 +137,7 @@ There are a few places where a name needs to be given to objects. Follow these r
- _Recordings_: should be given unique names. As such we have decided to simply
concatenate everything that went into defining it separated by underscore,
i.e. `NWBFileName_IntervalName_ElectrodeGroupName_PreprocessingParamsName`.
- _Sortings_: should be unique. Simply concatenates
- _SpikeSorting_: should be unique. Simply concatenates
`SpikeSorter_SorterParamName` to the name of the recording.
- _Waveforms_: should be unique. Concatenates `WaveformParamName` to the name of
the sorting.
Expand All @@ -157,8 +157,7 @@ There are a few places where a name needs to be given to objects. Follow these r
- Store an interval as `[start_time, stop_time]`. The list can be nested for a
set of disjoint intervals.
- Some recordings have explicit timestamps associated with each sample. This is
obtained by a system called PTP. In this system, time 0 is defined as 1 Jan
1970. Other (typically older) recordings do not and their times must be
obtained by a system called PTP. In this system, time 0 is defined as 1 Jan 1970. Other (typically older) recordings do not and their times must be
inferred from the TTL pulses from the camera (ask if this doesn't make sense).
- What is a valid interval? Because our experiments can be long, sometimes there
are missing samples. This can be due to many reasons, such as the commutator
Expand Down Expand Up @@ -190,11 +189,11 @@ There are a few places where a name needs to be given to objects. Follow these r
2. In `CITATION.cff`, update the `version` key to the new version string.
3. Make a pull request with these changes.
4. After merging these changes, run `git tag --sign -m "spyglass ${release}"
${release} origin/master` where `${release}` is replaced with the new version
${release} origin/master` where `${release}` is replaced with the new version
string.

- This step requires a
[GPG signing key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key).
- This step requires a
[GPG signing key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key).

1. Publish the new release tag. Run `git push origin ${release}`.
2. Generate distribution packages and upload them to PyPI following [these
Expand Down
2 changes: 1 addition & 1 deletion src/spyglass/utils/dj_merge_tables.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ def _merge_restrict_parents(
list
list of datajoint tables, parents of parts of Merge Table
"""
# .restict(restriction) does not work on returned part FreeTable
# .restrict(restriction) does not work on returned part FreeTable
# & part.fetch below restricts parent to entries in merge table
part_parents = [
parent
Expand Down

0 comments on commit 67e7014

Please sign in to comment.