Merge pull request #1045 from datalad-handbook/tmp

Random assortment of fixes
datalad-handbook · Oct 31, 2023 · e6c5132 · e6c5132
2 parents 719cd2c + 0c0e7a2
commit e6c5132
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 20 deletions.
diff --git a/docs/basics/101-109-rerun.rst b/docs/basics/101-109-rerun.rst
@@ -1,6 +1,6 @@
 .. _run2:
 
-DataLad, Re-Run!
+DataLad, re-run!
 ----------------
 
 .. index:: ! datalad command; rerun

diff --git a/docs/basics/101-116-sharelocal.rst b/docs/basics/101-116-sharelocal.rst
@@ -178,7 +178,7 @@ let's query git-annex where its content is stored:
 
    $ git annex whereis books/TLCL.pdf
 
-Oh, another :term:`shasum`! This time however not in a symlink...
+Oh, another :term:`shasum` - or, more specifically, a :term:`annex UUID`. This time however not in a symlink...
 "That's hard to read -- what is it?" your room mate asks. You can
 recognize a path to the dataset on your computer, prefixed with the user
 and hostname of your computer. "This", you exclaim, excited about your own realization,

diff --git a/docs/basics/101-118-sharelocal3.rst b/docs/basics/101-118-sharelocal3.rst
@@ -74,8 +74,7 @@ command:
 file content from the subdataset and it tried to unlock the output
 prior to the command execution. Note that because you did not retrieve
 the output, ``recordings/salt_logo_small.jpg``, yet, the missing content
-could not be unlocked. DataLad warns you about this, but proceeds
-successfully.
+could not be "unlocked", but is reportedly "removed" prior to the successful rerun.
 
 Your room mate now not only knows how exactly the resized file
 came into existence, but he can also reproduce your exact steps to

diff --git a/docs/basics/101-126-intro.rst b/docs/basics/101-126-intro.rst
@@ -1,6 +1,6 @@
 .. _intromidterm:
 
-A Data Analysis Project with DataLad
+A data analysis project with DataLad
 ------------------------------------
 
 

diff --git a/docs/basics/101-132-advancednesting.rst b/docs/basics/101-132-advancednesting.rst
@@ -1,6 +1,6 @@
 .. _nesting2:
 
-More on Dataset nesting
+More on dataset nesting
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 .. index:: ! nesting

diff --git a/docs/basics/101-180-FAQ.rst b/docs/basics/101-180-FAQ.rst
@@ -1,6 +1,6 @@
 .. _FAQ:
 
-Frequently Asked Questions
+Frequently asked questions
 --------------------------
 
 This section answers frequently asked questions about high-level DataLad

diff --git a/docs/basics/basics-run.rst b/docs/basics/basics-run.rst
@@ -1,7 +1,7 @@
 .. _1-002:
 .. _chapter_run:
 
-DataLad, Run!
+DataLad, run!
 -------------
 
 .. index:: ! Chapter; 2. DataLad Run

diff --git a/docs/beyond_basics/101-147-riastores.rst b/docs/beyond_basics/101-147-riastores.rst
@@ -1,6 +1,6 @@
 .. _riastore:
 
-Remote Indexed Archives for dataset storage and backup
+Remote indexed archives for dataset storage and backup
 ------------------------------------------------------
 
 If DataLad datasets should be backed-up, made available for collaborations

diff --git a/docs/intro/howto.rst b/docs/intro/howto.rst
@@ -32,7 +32,7 @@ On Windows systems, several different interfaces exist: The "CMD" Command Prompt
 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.
 
-Command Syntax
+Command syntax
 ==============
 
 Interactions with the shell take the form of commands, text-based instructions to your computer.
@@ -78,7 +78,7 @@ and the rest you will lookup in their documentation or via your favorite search
 DataLad commands naturally also come with many options, and in the next chapters
 and later examples you will get to see many of them.
 
-Basic Commands
+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:
 They can help you to *explore and navigate* in your file system, copy, move, or remove files, or create new directories.
@@ -134,7 +134,7 @@ Windows systems
     Set an :term:`environment variable` ``NAME`` to ``Value`` for your current terminal session
 
 
-The Prompt
+The prompt
 ==========
 When you first login on the command line, you are greeted with "the prompt",
 and it will likely look similar to this:
@@ -260,7 +260,7 @@ In order to quickly get home, you could use
 
 More information on Windows paths can be found `here <https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file>`_.
 
-Text Editors
+Text editors
 ============
 
 Text editors are a crucial tool for any Linux user, but regardless of your operating system,

diff --git a/docs/intro/installation.rst b/docs/intro/installation.rst
@@ -102,7 +102,7 @@ Python:
        Such alternative installations may even be or become the default.
        This can cause confusing behavior, because each Python installation will have different package versions installed.
 
-       To verify if there are multiple installation, open the windows command line ``cmd.exe`` and run ``where python``.
+       To verify if there are multiple installations, open the windows command line ``cmd.exe`` and run ``where python``.
        This will list all variants of ``python.exe``.
        There will be one in ``WindowsApps``, which is only a link to the Windows app store.
        Make sure the Python version that you installed is listed too.
@@ -138,8 +138,8 @@ Git:
 
 Git-annex:
     There are two convenient ways to install git-annex. The first is `downloading the installer from git-annex' homepage <https://git-annex.branchable.com/install/Windows>`_. The other is to deploy git-annex via the `DataLad installer`_.
-    The latter option requires the installation of the datalad-installer, Once
-    Python is available, it can be done with the Python package manager
+    The latter option requires the installation of the datalad-installer.
+    Once Python is available, it can be done with the Python package manager
     :shcmd:`pip`. Open a command prompt and run:
 
     .. code-block:: bat
@@ -181,7 +181,7 @@ One attractive alternative approach is Conda_, a completely different approach i
    :name: ww-wsl2
 
    With the Windows Subsystem for Linux, you will be able to use a Unix system
-   despite being on Windows.  You need to have a recent build of Windows 10 in
+   despite being on Windows.  You need to have a recent build of Windows in
    order to get WSL2 -- we do not recommend WSL1.
 
    You can find out how to install the Windows Subsystem for Linux at
@@ -199,7 +199,7 @@ look different from what is displayed in the code examples of the book, and
 that some dependencies for additional functionality are not available for
 Windows. Dedicated notes,
 "``Windows-wit``\s", contain important information, alternative commands, or
-warnings. If you on a native Windows 10 system, you should pay close
+warnings. If you on a native Windows system, you should pay close
 attention to them.
 
 .. _mac:

diff --git a/docs/intro/philosophy.rst b/docs/intro/philosophy.rst
@@ -29,7 +29,7 @@ As built-in, but *optional* features, DataLad yields FAIR_ resources -- for exam
 can be easily shared *should the user want this*.
 
 
-On Data
+On data
 ^^^^^^^
 
 Everyone uses data. But once it exists, it does not suffice for most data
@@ -85,7 +85,7 @@ managing the evolution of digital objects in a way that fulfills the FAIR_
 principles.
 
 
-The DataLad Philosophy
+The DataLad philosophy
 ^^^^^^^^^^^^^^^^^^^^^^
 From a software point of view, DataLad is a command line tool, with an additional
 Python API to use its features within your software and scripts.