Skip to content

Commit

Permalink
Merge pull request #1062 from datalad-handbook/mslw-patch-2
Browse files Browse the repository at this point in the history
Some typo fixes and punctuation tweaks
  • Loading branch information
adswa authored Nov 2, 2023
2 parents a816e78 + 53fb38d commit b6a197b
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/basics/101-130-yodaproject.rst
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,7 @@ dataset:

$ git log --oneline

"Wow, this is so clean an intuitive!" you congratulate yourself. "And I think
"Wow, this is so clean and intuitive!" you congratulate yourself. "And I think
this was and will be the fastest I have ever completed a midterm project!"
But what is still missing is a human readable description of your dataset.
The YODA procedure kindly placed a ``README.md`` file into the root of your
Expand Down
2 changes: 1 addition & 1 deletion docs/beyond_basics/101-162-springcleaning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ history. Before you use it, please make sure to read its help page thoroughly.
Its `GitHub repository <https://github.com/newren/git-filter-repo>`_ contains
more and more detailed instructions, but it is possible to install via :term:`pip`
(``pip install git-filter-repo``), and available via standard package managers
for MacOS and some Linux distributions (mostly rpm-based ones).
for macOS and some Linux distributions (mostly rpm-based ones).

The general procedure you should follow is the following:

Expand Down
2 changes: 1 addition & 1 deletion docs/beyond_basics/101-179-gitignore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ your dataset to be messy, if you want to be.
Git -- and consequently DataLad -- will not bother you about any of the files
or file types you have specified. The following snippet defines a typical
collection of ignored files to be defined across different platforms, and should work on Unix-like systems (like MacOS and Linux distributions).
collection of ignored files to be defined across different platforms, and should work on Unix-like systems (like macOS and Linux distributions).

.. code-block:: bash
Expand Down
10 changes: 5 additions & 5 deletions docs/intro/howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ Luckily, the set of possible commands is limited, and even without prior experie
The shell (also called a terminal, console, or CLI) is an interactive,
text based interface. If you have used Matlab or IPython, then you are already familiar
with the basics of a command line interface.
On Unix-like systems (e.g., running Linux or macos), the shell application is usually called "terminal".
On Unix-like systems (e.g., running Linux or macOS), the shell application is usually called "terminal".
On Windows systems, several different interfaces exist: The "CMD" Command Prompt and the Powershell are natively installed, and the Git Bash (provided by Git for Windows) or Anaconda prompt CLI (provided by Anaconda or Miniconda) can come with the installation of the respective software tool.
We recommend using CMD, or, if you have them installed already and prefer them over the CMD, the Git Bash or Anaconda prompt.
As later parts in this section will show, shells under Windows may use different commands than shells under Linux and macos systems.
As later parts in this section will show, shells under Windows may use different commands than shells under Linux and macOS systems.

Command syntax
==============
Expand Down Expand Up @@ -80,7 +80,7 @@ and later examples you will get to see many of them.

Basic commands
==============
The following commands, split between Unix-like (e.g., Linux, macos) and Windows environments, can appear in our examples or are generally useful to know:
The following commands, split between Unix-like (e.g., Linux, macOS) and Windows environments, can appear in our examples or are generally useful to know:
They can help you to *explore and navigate* in your file system, copy, move, or remove files, or create new directories.
Note that the Git Bash on Windows emulates a Unix environment in which you could use Unix commands despite being on Windows.

Expand Down Expand Up @@ -164,7 +164,7 @@ I can run the following command:
$ mkdir /home/me/awesome_datalad_project
If I want to do the same in Window's CMD, I'd do
If I want to do the same in Windows CMD, I'd do

.. code-block::
Expand Down Expand Up @@ -306,7 +306,7 @@ a common syntax.
Two common shells are:

``Bash``
The bourne-again shell (``bash``) is the default shell on many \*nix systems (most Linux distros, MacOS).
The bourne-again shell (``bash``) is the default shell on many \*nix systems (most Linux distros, macOS).
``zsh``
The Z shell (``zsh``) comes with many additional features, the highlights being:
shared history across running shells, smarter tab-completion, spelling correction, and better theming.
Expand Down
6 changes: 3 additions & 3 deletions docs/intro/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In general, the DataLad installation requires Python 3 (see the
why this is required), :term:`Git`, and :term:`git-annex`, and for some
functionality `7-Zip <https://7-zip.org>`_. The instructions below detail how
to install the core DataLad tool and its dependencies on common operating
systems. They do not cover the various :term:`DataLad extension`'s that need to be installed separately, if desired.
systems. They do not cover the various :term:`DataLad extension`\s that need to be installed separately, if desired.

.. find-out-more:: Python 2, Python 3, what's the difference?
:name: fom-py2v3
Expand Down Expand Up @@ -53,7 +53,7 @@ systems. They do not cover the various :term:`DataLad extension`'s that need to
resulting in errors during installation and execution.

But does that mean that you should uninstall Python 2? **No**! Keep it
installed, especially if you are using Linux or MacOS. Python 2 existed for
installed, especially if you are using Linux or macOS. Python 2 existed for
20 years and numerous software has been written for it. It is quite likely
that some basic operating system components or legacy software on your
computer is depending on it, and uninstalling a preinstalled Python 2 from
Expand Down Expand Up @@ -226,7 +226,7 @@ Alternatively, you can exclusively use :shcmd:`brew` for DataLad's non-Python
dependencies, and then check the :find-out-more:`on how to install DataLad via
Python's package manager <fom-macosx-pip>`.

.. find-out-more:: Install DataLad via pip on MacOSX
.. find-out-more:: Install DataLad via pip on macOS
:name: fom-macosx-pip
:float: tbp

Expand Down
4 changes: 2 additions & 2 deletions docs/intro/narrative.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ in the example below (it shows the creation of a DataLad dataset):

.. code-block:: bash
# this is a comment used for additional explanations.
# This is a comment used for additional explanations.
# Anything preceded by $ is a command to try.
# if the line starts with neither # nor $, its the output of a command
# If the line starts with neither # nor $, it is an output of a command.
$ datalad create myfirstrepo
[INFO ] Creating a new annex repo at /home/me/DataLad-101
create(ok): /home/me/DataLad-101 (dataset)
Expand Down

0 comments on commit b6a197b

Please sign in to comment.