Skip to content

Commit 5b87da5

Browse files
authored
Merge pull request #71 from yarikoptic/enh-codespell
Add codespell support (config, workflow to detect/not fix) and make it fix few typos
2 parents 7911734 + 1bf5909 commit 5b87da5

File tree

5 files changed

+33
-3
lines changed

5 files changed

+33
-3
lines changed

.codespellrc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[codespell]
2+
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
3+
# ./labguide/research is generated from .md
4+
skip = .git*,*.pdf,*.css,*.min.*,.codespellrc,site_libs,search.json,publications.html,additional_pubs.csv,./docs/labguide/*/*.html,./academicdb/*.csv
5+
check-hidden = true
6+
ignore-regex = \bNichols TE\b
7+
# ignore-words-list =

.github/workflows/codespell.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Codespell configuration is within .codespellrc
2+
---
3+
name: Codespell
4+
5+
on:
6+
push:
7+
branches: [main]
8+
pull_request:
9+
branches: [main]
10+
11+
permissions:
12+
contents: read
13+
14+
jobs:
15+
codespell:
16+
name: Check for spelling errors
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
- name: Codespell
23+
uses: codespell-project/actions-codespell@v2

labguide/environment/code_of_conduct.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Conduct](https://adminguide.stanford.edu/chapter-1/subchapter-1/policy-1-1-1).
1212
For definitions of an act of intolerance & hate crime escalation policy
1313
please see this page on University [AOI](https://deanofstudents.stanford.edu/acts-intolerance-protocol/overview/definitions).
1414
If you wish to speak with someone outside of the lab regarding an
15-
incident that occured in or outside of the lab, the university has
15+
incident that occurred in or outside of the lab, the university has
1616
this[ list of
1717
resources.](https://deanofstudents.stanford.edu/acts-intolerance-protocol/talk-someone)
1818

labguide/research/intellectual_property.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All products of research at Stanford (including data and code) are the property
44

55
As discussed in the section on [data management and sharing](https://poldracklab.github.io/research/data_management.html), all data collected within our laboratory is meant to be shared upon submission of the related paper. In cases where these data can be deidentified they will be shared under a public domain dedication (CC0), which places no restrictions on their use by other researchers. Thus, any researcher can continue to use those data once they leave the lab. In other cases it may be necessary to restrict data sharing (e.g. when the data cannot be deidentified), in which case researchers will need to obtain a data use agreement from Stanford in order to access those data at their new institution. Dr. Poldrack commits to supporting any such requests, unless they violate other obligations of his or the University.
66

7-
In many cases we use data within the lab under Data Use Agreements (such as the ABCD or HCP datasets), and any researcher wishing to use such datasets must be explcitly listed on the DUA. Once a researcher is no longer included in the Stanford DUA for a particular dataset, they must no longer access the dataset via Stanford computer systems.
7+
In many cases we use data within the lab under Data Use Agreements (such as the ABCD or HCP datasets), and any researcher wishing to use such datasets must be explicitly listed on the DUA. Once a researcher is no longer included in the Stanford DUA for a particular dataset, they must no longer access the dataset via Stanford computer systems.
88

99
## Research ideas
1010

labguide/research/statistical_methods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
the preregistration document.
1313
- The nature of grouping for
1414
multiple testing corrections (e.g., parameter within single models,
15-
sets ot models, etc) should be pre-specified.
15+
sets of models, etc) should be pre-specified.
1616
- For fMRI data, if using
1717
cluster-based thresholding the cluster forming threshold must be Z ≥
1818
3.1 if using parametric thresholding. There are no restrictions on

0 commit comments

Comments
 (0)