Skip to content

Fix a few typos in comments and in documentation and help text #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix a few typos in comments and in documentation and help text #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
07502e3
Fix typo in CLI help text (querry→query)
musicinmybrain Aug 26, 2023
22f3d39
Use “split” instead of nonstandard “splitted”
musicinmybrain Aug 26, 2023
c50972f
Correct “we writen” to “be written” in a doc string
musicinmybrain Aug 26, 2023
aeedc58
Fix a couple of typos in comments
musicinmybrain Aug 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions brukerapi/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def main():
dest="path_out",
type=str,
required=False,
help="Folder to save splitted data sets",
help="Folder to save split data sets",
)
parser_split.add_argument(
"-s",
Expand All @@ -81,7 +81,7 @@ def main():
parser_split.set_defaults(func=split)

# filter sub-command
parser_filter = subparsers.add_parser('filter', help='get files based on querry')
parser_filter = subparsers.add_parser('filter', help='get files based on query')
parser_filter.add_argument(
"-i",
"--input",
Expand Down
2 changes: 1 addition & 1 deletion brukerapi/jcampdx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,7 @@ def divide_jcampdx_line(cls, line):

@classmethod
def split_key_value_pair(cls, line):
# ASSUMPTION the first occurence of = in jcampdx line divides key and value pair
# ASSUMPTION the first occurrence of = in jcampdx line divides key and value pair
# example:
match = re.search(GRAMMAR['EQUAL_SIGN'], line)
key = line[0:match.start()]
Expand Down
12 changes: 6 additions & 6 deletions brukerapi/splitters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ def split(self, dataset, select=None, write=False, path_out=None, **kwargs):
# number of samples in self.fg dimension
fg_size = dataset.shape[fg_abs_index]

# If no index is specified, all elements of given dimension will be splited
# If no index is specified, all elements of given dimension will be split
if select is None:
select = list(range(0, fg_size))

Expand Down Expand Up @@ -266,17 +266,17 @@ def split(self, dataset, write=False, path_out=None):
This functionality might be used for instance when converting data to a different data format.

:param dataset: 2dseq dataset with multiple slice packages
:param write: if True, splitted data sets will we writen to drive
:param write: if True, split data sets will be written to drive
:param path_out: a path to store data sets (optional)
:return: list of splitted data sets
:return: list of split data sets
"""

try:
VisuCoreSlicePacksSlices = dataset['VisuCoreSlicePacksSlices'].value
except KeyError:
print('Parameter VisuCoreSlicePacksSlices not found')

# list of splitted data sets
# list of split data sets
datasets = []

# range of frames of given slice package
Expand All @@ -303,7 +303,7 @@ def split(self, dataset, write=False, path_out=None):
# construct a new Dataset, without loading data, the data will be supplied later
dataset_ = Dataset(dataset.path.parents[1] / name, load=False)

# SPLIT parameteres
# SPLIT parameters
dataset_.parameters = self._split_parameters(dataset, frame_range, fg_rel_index, fg_abs_index, sp_index, frame_count)

# construct properties from the new set of parameters
Expand Down Expand Up @@ -391,4 +391,4 @@ def _split_VisuCoreSlicePacksSliceDist(self, visu_pars_, sp_index):
VisuCoreSlicePacksSliceDist = visu_pars_['VisuCoreSlicePacksSliceDist']
value = int(VisuCoreSlicePacksSliceDist.value[sp_index])
VisuCoreSlicePacksSliceDist.value = value
VisuCoreSlicePacksSliceDist.size = 1
VisuCoreSlicePacksSliceDist.size = 1