Skip to content

Commit

Permalink
Update branch name references from master to main (#664)
Browse files Browse the repository at this point in the history
* Update branch name references from master to main

* Change branch name from master to main in md and workflow files

* Fix typo
  • Loading branch information
ehennestad authored Feb 4, 2025
1 parent e778e38 commit 9393715
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion +tests/+unit/nwbExportTest.m
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ function testExportNwbFileWithMissingRequiredLink(testCase)
testCase.verifyError(@(f, fn) nwbExport(testCase.NwbObject, nwbFilePath), ...
'NWB:RequiredPropertyMissing')

% Clean up: the NwbObject is re-used by other tests.
% Clean up: the NwbObject is reused by other tests.
testCase.NwbObject.general_intracellular_ephys.remove('Electrode');
end

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/master/.github/CODE_OF_CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/main/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/master/.github/CODE_OF_CONDUCT.md)
- label: I agree to follow this project's [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/main/.github/CODE_OF_CONDUCT.md)
required: true
- label: Have you ensured this bug was not already [reported](https://github.com/NeurodataWithoutBorders/matnwb/issues)?
required: true
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/master/.github/CODE_OF_CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/main/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/master/.github/CODE_OF_CONDUCT.md)
- label: I agree to follow this project's [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/main/.github/CODE_OF_CONDUCT.md)
required: true
- label: Have you ensured this change was not already [requested](https://github.com/NeurodataWithoutBorders/matnwb/issues)?
required: true
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/master/.github/CODE_OF_CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/main/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/master/.github/CODE_OF_CONDUCT.md)
- label: I agree to follow this project's [Code of Conduct](https://github.com/neurodatawithoutborders/matnwb/blob/main/.github/CODE_OF_CONDUCT.md)
required: true
- label: Have you ensured this change was not already [requested](https://github.com/NeurodataWithoutBorders/matnwb/issues)?
required: true
4 changes: 2 additions & 2 deletions .github/workflows/run_codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ name: Codespell
on:
pull_request:
branches:
- master
- main
push:
branches:
- master
- main

jobs:
codespell:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/run_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ name: Run tests
on:
pull_request:
branches:
- master
- main
paths-ignore:
- "*.md"
- "*.codespellrc"
- ".github/**"
push:
branches:
- master
- main

jobs:
run_tests:
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@
<a href="https://matlab.mathworks.com/open/github/v1?repo=NeurodataWithoutBorders/matnwb&file=tutorials/basicUsage.mlx">
<img src="https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg" alt="MATLAB Online">
</a>
<a href="https://codecov.io/gh/NeurodataWithoutBorders/matnwb">
<img src="https://codecov.io/gh/NeurodataWithoutBorders/matnwb/branch/master/graph/badge.svg?token=apA7F24NsO" alt="Codecov">
<a href="https://codecov.io/gh/NeurodataWithoutBorders/matnwb" >
<img src="https://codecov.io/gh/NeurodataWithoutBorders/matnwb/graph/badge.svg?token=apA7F24NsO" alt="Codecov"/>
</a>
<a href="https://github.com/NeurodataWithoutBorders/matnwb/actions/workflows/run_tests.yml?query=event%3Apush+branch%3Amaster">
<img src="https://github.com/NeurodataWithoutBorders/matnwb/actions/workflows/run_tests.yml/badge.svg?branch=master" alt="Run tests">
<a href="https://github.com/NeurodataWithoutBorders/matnwb/actions/workflows/run_tests.yml?query=event%3Apush+branch%3Amain">
<img src="https://github.com/NeurodataWithoutBorders/matnwb/actions/workflows/run_tests.yml/badge.svg?branch=main" alt="Run tests">
</a>
<a href="https://github.com/NeurodataWithoutBorders/matnwb/actions/workflows/run_codespell.yml?query=event%3Apush+branch%3Amaster">
<img src="https://github.com/NeurodataWithoutBorders/matnwb/actions/workflows/run_codespell.yml/badge.svg?branch=master" alt="Codespell">
<a href="https://github.com/NeurodataWithoutBorders/matnwb/actions/workflows/run_codespell.yml?query=event%3Apush+branch%3Amain">
<img src="https://github.com/NeurodataWithoutBorders/matnwb/actions/workflows/run_codespell.yml/badge.svg?branch=main" alt="Codespell">
</a>
</h4>

Expand Down Expand Up @@ -57,7 +57,7 @@ nwbFile = nwbRead('/path/to/file.nwb');
The returned NwbFile object provides an in-memory view of the underlying NWB data. For more information, see the [MatNWB Documentation](https://matnwb.readthedocs.io/en/latest/pages/getting_started/file_read.html#reading-with-matnwb)

### Writing an NWB File
The building blocks of an NWB file are the neurodata types defined in the [NWB Format Specification](https://nwb-schema.readthedocs.io/en/latest/). In MatNWB, these types are autogenerated from the schema specifications and located as classes in the [`+types`](https://github.com/NeurodataWithoutBorders/matnwb/tree/master/%2Btypes) [namespace](https://www.mathworks.com/help/matlab/matlab_oop/scoping-classes-with-packages.html) of the MatNWB root directory.
The building blocks of an NWB file are the neurodata types defined in the [NWB Format Specification](https://nwb-schema.readthedocs.io/en/latest/). In MatNWB, these types are autogenerated from the schema specifications and located as classes in the [`+types`](https://github.com/NeurodataWithoutBorders/matnwb/tree/main/%2Btypes) [namespace](https://www.mathworks.com/help/matlab/matlab_oop/scoping-classes-with-packages.html) of the MatNWB root directory.

To create an NWB file, you can create neurodata objects, add them to an NwbFile object and write to disk using the `nwbExport` function (detailed examples are provided in the tutorials):
```matlab
Expand All @@ -78,7 +78,7 @@ The `generateCore` command can generate classes for older versions of the nwb sc
generateCore('2.1.0'); % generates classes for NWB schema version 2.1.0
```

Supported schema versions are provided in the MatNWB root directory under [`nwb-schema`](https://github.com/NeurodataWithoutBorders/matnwb/tree/master/nwb-schema).
Supported schema versions are provided in the MatNWB root directory under [`nwb-schema`](https://github.com/NeurodataWithoutBorders/matnwb/tree/main/nwb-schema).


## Tutorials
Expand Down Expand Up @@ -137,7 +137,7 @@ The NWB schema has regular updates and is open to addition of new types along wi
For those planning on using MatNWB alongside PyNWB, please keep the following in mind:
- MatNWB is dependent on the schema, which may not necessarily correspond with your PyNWB schema version. Please consider overwriting the contents within MatNWB's **~/schema/core** directory with the generating PyNWB's **src/pynwb/data directory** and running `generateCore` to ensure compatibility between systems.

The `master` branch of this repository is considered perpetually unstable. If you want to stay on the safer side, please consider downloading the more stable releases from the [Releases](https://github.com/NeurodataWithoutBorders/matnwb/releases) page. Most releases will coincide with nwb-schema releases and guarantee compatibility of new features introduced with the schema release along with backwards compatibility with all previous nwb-schema releases.
The `main` branch of this repository is considered perpetually unstable. If you want to stay on the safer side, please consider downloading the more stable releases from the [Releases](https://github.com/NeurodataWithoutBorders/matnwb/releases) page. Most releases will coincide with nwb-schema releases and guarantee compatibility of new features introduced with the schema release along with backwards compatibility with all previous nwb-schema releases.

This package reads and writes NWB 2.0 files and does not support older formats.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def setup(app):

def linkcode_resolve(domain, info):
filename = info['module'].replace('.', '/')
source_url = 'https://github.com/NeurodataWithoutBorders/matnwb/blob/master/'+filename+'/'+info['fullname']+'.m'
source_url = 'https://github.com/NeurodataWithoutBorders/matnwb/blob/main/'+filename+'/'+info['fullname']+'.m'
print(source_url)
return source_url

Expand Down

0 comments on commit 9393715

Please sign in to comment.