Skip to content
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.

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

Resolve all 're contractions in the Basics #1147

Merged
merged 1 commit into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs/basics/101-102-populate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ in the same commit. And ... what happens if I have files I do not want to track?
:dlcmd:`save -m "some commit message"` would save all of what is currently
untracked or modified in the dataset into the history!"

Regarding your first remark, you're absolutely right!
Regarding your first remark, you are absolutely right!
It is good practice to save only those changes
together that belong together. We do not want to squish completely unrelated changes
into the same spot of our history, because it would get very nasty should we want to
Expand Down Expand Up @@ -266,7 +266,7 @@ Let's give :dlcmd:`save` precisely this file by specifying its path after the co

$ datalad save -m "add reference book about git" books/progit.pdf

Regarding your second remark, you're right that a :dlcmd:`save` without a
Regarding your second remark, you are right that a :dlcmd:`save` without a
path specification would write all of the currently untracked files or modifications
to the history. But check the :find-out-more:`on how to tell it otherwise <fom-save-updated-only>`.

Expand Down
2 changes: 1 addition & 1 deletion docs/basics/101-103-modify.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ and save the file in DataLad:
$ datalad save -m "add note on datalad save"

Let's take another look into our history to see the development of this file.
We're using :gitcmd:`log -p -n 2` to see last two commits and explore
We are using :gitcmd:`log -p -n 2` to see last two commits and explore
the difference to the previous state of a file within each commit.

.. runrecord:: _examples/DL-101-103-107
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/101-105-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ of a DataLad dataset! Shall we try whether we can install that?"
now instead of looking at slides for hours is my preferred type of learning anyway",
you think as you fire up your terminal and navigate into your ``DataLad-101`` dataset.

In this demonstration, we're using one of the many openly available datasets that
In this demonstration, we are using one of the many openly available datasets that
DataLad provides in a public registry that anyone can access. One of these datasets is a
collection of audio recordings of a great podcast, the longnow seminar series [#f2]_.
It consists of audio recordings about long-term thinking, and while the DataLad-101
Expand Down
4 changes: 2 additions & 2 deletions docs/basics/101-108-run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ list of speakers and titles to cross out what they've already listened
to, and ask you to prepare such a list.

"Mhh... probably there is a DataLad way to do this... wasn't there also
a note about metadata extraction at some point?" But as we're not that
a note about metadata extraction at some point?" But as we are not that
far into the lectures, you decide to write a short shell script
to generate a text file that lists speaker and title
name instead.

To do this, we're following a best practice that will reappear in the
To do this, we are following a best practice that will reappear in the
later section on :ref:`YODA principles <yoda>`: Collecting all
additional scripts that work with content of a subdataset *outside*
of this subdataset, in a dedicated ``code/`` directory,
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/101-109-rerun.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ So you go ahead and find the commit :term:`shasum` in your history:

Take that shasum and paste it after :dlcmd:`rerun`
(the first 6-8 characters of the shasum would be sufficient,
here we're using all of them).
here we are using all of them).

.. runrecord:: _examples/DL-101-109-106
:language: console
Expand Down
4 changes: 2 additions & 2 deletions docs/basics/101-110-run2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ in the hidden paths
.. runrecord:: _examples/DL-101-110-101
:language: console
:workdir: dl-101/DataLad-101
:notes: We saw a very simple datalad run. Now we're going to extend it with useful options. Narrative: prepare talk about dataset, add logo to slides. For this, we'll try to resize a logo in the meta data of the subdataset
:notes: We saw a very simple datalad run. Now we are going to extend it with useful options. Narrative: prepare talk about dataset, add logo to slides. For this, we'll try to resize a logo in the meta data of the subdataset
:cast: 02_reproducible_execution

$ ls recordings/longnow/.datalad/feed_metadata/*jpg

For the slides you decide to prepare images of size 400x400 px, but
the logos' original size is much larger (both are 3000x3000 pixel). Therefore
let's try to resize the images -- currently, they're far too large to fit on a slide.
let's try to resize the images -- currently, they are far too large to fit on a slide.

To resize an image from the command line we can use the Unix
command ``convert -resize`` from the `ImageMagick tool <https://imagemagick.org/index.php>`_.
Expand Down
4 changes: 2 additions & 2 deletions docs/basics/101-114-txt2git.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ I was able to modify this despite giving it to DataLad to track, with
no permission denied errors whatsoever! How does that work?"

This night, though, your question stays unanswered and you fall into a restless
sleep filled with bad dreams about "permission denied" errors. The next day you're
sleep filled with bad dreams about "permission denied" errors. The next day you are
the first student in your lecturer's office hours.

"Oh, you're really attentive. This is a great question!" our lecturer starts
"Oh, you are really attentive. This is a great question!" our lecturer starts
to explain.

.. figure:: ../artwork/src/teacher.svg
Expand Down
4 changes: 2 additions & 2 deletions docs/basics/101-116-sharelocal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ of undesired, or uncontrolled modification.
To demonstrate how to share a DataLad dataset on a common file system,
we will pretend that your personal computer
can be accessed by other users. Let's say that
your room mate has access, and you're making sure that there is
your room mate has access, and you are making sure that there is
a ``DataLad-101`` dataset in a different place on the file system
for him to access and work with.

Expand All @@ -60,7 +60,7 @@ will be using a particular dataset of your own creation as input for
one or more projects.

"Awesome!" exclaims your room mate as you take out your laptop to
share the dataset. "You're really saving my ass
share the dataset. "You are really saving my ass
here. I'll make up for it when we prepare for the final", he promises.

To install ``DataLad-101`` into a different part
Expand Down
4 changes: 2 additions & 2 deletions docs/basics/101-119-sharelocal4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ All of what you have seen about sharing dataset was really
cool, and for the most part also surprisingly intuitive.
:dlcmd:`run` commands or file retrieval worked exactly as
you imagined it to work, and you begin to think that slowly but
steadily you're getting a feel about how DataLad really works.
steadily you are getting a feel about how DataLad really works.

But to be honest, so far, sharing the dataset with DataLad was
also remarkably unexciting given that you already knew most of
the dataset magic that your room mate currently is still
mesmerized about.
To be honest, you're not yet certain whether
To be honest, you are not yet certain whether
sharing data with DataLad really improves your life up
until this point. After all, you could have just copied
your directory into your ``mock_user`` directory and
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/101-121-siblings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ do not use Git, but a later section will get into the details of what
the meaning of ":term:`merge`", ":term:`branch`", "refs"
or ":term:`main`" is.

For now, you're happy to have the changes your room mate made available.
For now, you are happy to have the changes your room mate made available.
This is how it should be! You helped him, and he helps you. Awesome!
There actually is a wonderful word for it: *Collaboration*.
Thus, without noticing, you have successfully collaborated for the first
Expand Down
6 changes: 3 additions & 3 deletions docs/basics/101-122-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ student from the row behind you. Personally, you'd also
be much more excited
about any hands-on lecture filled with commands. But the
recent lecture about :term:`git-annex` and the :term:`object-tree`
was surprisingly captivating, so you're actually looking forward to today.
was surprisingly captivating, so you are actually looking forward to today.
"Shht! I want to hear this!", you shush him with a wink.

"We will start by looking into the very first configuration
Expand Down Expand Up @@ -72,8 +72,8 @@ really cool is that all tools we'll be looking at -- Git, git-annex,
and DataLad -- can be configured using the :gitcmd:`config`
command [#f1]_. Therefore, once you understand the syntax of this
command, you already know half of what's relevant. The other half
is understanding what you're doing. Now then, let's learn *how*
to configure settings, but also *understand* what we're doing
is understanding what you are doing. Now then, let's learn *how*
to configure settings, but also *understand* what we are doing
with these configurations."

"This seems easy enough", you think. Let's see what types of
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/101-123-config2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ you already know some core Git configurations such as name, email, and editor. E
important, you know how to configure git-annex's content management based on ``largefile``
rules, and you understand the variables within ``.gitmodules`` or the sections
in ``.git/config``. Slowly, you realize with pride,
you're more and more becoming a DataLad power-user.
you are more and more becoming a DataLad power-user.

Write a note about configurations in datasets into ``notes.txt``.

Expand Down
2 changes: 1 addition & 1 deletion docs/basics/101-130-yodaproject.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ widely available -- a perfect dataset for your midterm project!
.. importantnote:: Turn data analysis into dynamically generated documents

Beyond the contents of this section, we have transformed the example analysis also into a template to write a reproducible paper.
If you're interested in checking that out, please head over to `github.com/datalad-handbook/repro-paper-sketch/ <https://github.com/datalad-handbook/repro-paper-sketch>`_.
If you are interested in checking that out, please head over to `github.com/datalad-handbook/repro-paper-sketch/ <https://github.com/datalad-handbook/repro-paper-sketch>`_.

Raw data as a modular, independent entity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/101-133-containersrun.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ For this, we will pull an image from Singularity hub. This image was made
for the handbook, and it contains the relevant Python setup for
the analysis. Its recipe lives in the handbook's
`resources repository <https://github.com/datalad-handbook/resources>`_.
If you're curious how to create a Singularity image, the :find-out-more:`on this topic <fom-container-creation>` has some pointers:
If you are curious how to create a Singularity image, the :find-out-more:`on this topic <fom-container-creation>` has some pointers:

.. index::
pair: build container image; with Singularity
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/101-135-help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ In situations where there is no obvious reason for a command to fail, it can be
This allows you to gain more insights into the actions DataLad and its underlying tools are taking, where *exactly* they fail, and to even play around with the program at the state of the failure.

:term:`Debugging` and :term:`logging` are not as complex as these terms may sound if you have never consciously debugged.
Procedurally, it can be as easy as adding an additional flag to a command call, and cognitively, it can be as easy as engaging your visual system in a visual search task for the color red or the word "error", or reading more DataLad output than you're used to.
Procedurally, it can be as easy as adding an additional flag to a command call, and cognitively, it can be as easy as engaging your visual system in a visual search task for the color red or the word "error", or reading more DataLad output than you are used to.
The paragraphs below start with the general concepts, and collect concrete debugging strategies for different problems.

.. _logging:
Expand Down
6 changes: 3 additions & 3 deletions docs/basics/101-136-filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Below you will find common questions about file system
management operations, and each question outlines caveats and
solutions with code examples you can paste into your own terminal.
Because these code snippets will add many commits to your
dataset, we're cleaning up within each segment with
dataset, we are cleaning up within each segment with
common git operations that manipulate the datasets
history -- be sure to execute these commands as well (and
be sure to be in the correct dataset).
Expand Down Expand Up @@ -130,7 +130,7 @@ only using Git tools only, outlined in the :find-out-more:`on faster renaming <f
$ git reset --hard HEAD~1
$ datalad status

Now we're checking out how to rename files and commit this operation
Now we are checking out how to rename files and commit this operation
using only Git:
A Git-specific way to rename files is the ``git mv`` command:

Expand Down Expand Up @@ -877,7 +877,7 @@ or :term:`GitLab`, these files would not be available to others, because annexed
dataset contents cannot be published to these services.
Even though you could find a third party service of your choice
and publish your dataset *and* the annexed data (see section :ref:`sharethirdparty`),
you're feeling lazy today. And since it
you are feeling lazy today. And since it
is only two files, and they are quite small, you decide to store them in Git --
this way, the files would be available without configuring an external data
store.
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/101-137-history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ done. For the rest of the lecture, call me Google!"
Fixing (empty) commit messages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

From the back of the lecture hall comes a question you're really glad
From the back of the lecture hall comes a question you are really glad
someone asked: "It has happened to me that I accidentally did a
:dlcmd:`save` and forgot to specify the commit message,
how can I fix this?".
Expand Down