Follow these general steps to create a README file. The specific details for each operating system are detailed below.
@@ -921,7 +921,7 @@Use the File
Manager to create a new directory called oddsong.
Inside that folder, create a new text file called
@@ -948,7 +948,7 @@
Use the Finder
file manager to create a new directory called oddsong.
Inside that folder, create a new text file called
@@ -1160,7 +1160,7 @@
For more information on this topic, please see the following resources:
@@ -1197,7 +1197,7 @@A markup language is a system of special characters that are used to @@ -1232,7 +1232,7 @@
Follow these steps to rename README.txt to
README.md.
Use File
Explorer to rename
the file from README.txt to README.md.
README.md.Use the File
Manager to rename
the file from README.txt to README.md.
mv README.txt README.md
Use the Finder
to rename
the file from README.txt to README.md.
We can create the commonly-used headers used in READMEs by using the Markdown syntax shown below
@@ -1468,7 +1468,7 @@The Markdown syntax for bold font is to wrap the text in two
asterixes **. This may be applied to single words or to
@@ -2456,7 +2456,7 @@
Without syntax highlighting:
Classes use capitalised words, where each word in a phrase starts with an upper-case letter and there are no spaces between them.
Classes use capitalised words
Python comments
start with a hash character (#) and are ignored when the
code runs.
+= in the documentation for that
programming language.
Python comments
start with a hash character (#) and are ignored when the
code runs.
In the Python programming language, we can tell the user what type of
data we expect each variable to contain by using the syntax below. This
colon means that the age variable should contain a value
@@ -2896,7 +2896,7 @@
There is no type hinting feature in base R, although some packages
are available that enable this. Here, the L symbol at the
end of the number tells the R interpreter that this is an integer data
@@ -2935,7 +2935,7 @@
Below is the source code for a simple R function that calculates the sum of two numbers.
In R, there is no inbuilt functionality for annotating the expected @@ -3011,7 +3011,7 @@
None of these code examples will cause an error because type hints are just passive labels that document our code. They @@ -3914,7 +3914,7 @@
The Python code uses sys.path,
a list of locations to search for code. By modifying the Python
@@ -3945,7 +3945,7 @@
This reStructuredText (reST) markup language has the following elements:
@@ -4168,7 +4168,7 @@On Windows operating systems, press the Windows key and type in “command”. The start menu will find the “Command Prompt” app. Press Enter or click on the Command Prompt icon to launch the @@ -4188,7 +4188,7 @@
On Ubuntu, press Ctrl + Alt + T to open a terminal.
You can also open Dash and search for “Terminal”. For detailed
instructions, please read Opening
@@ -4203,7 +4203,7 @@ BASH
bob@myUbuntuPC:~$
Please read Open or quit Terminal on Mac on the Terminal User Guide for macOS.
@@ -4237,7 +4237,7 @@On Windows, the dir command is used to list the contents of a directory. When you enter this command and press Enter
@@ -4267,7 +4267,7 @@To show the contents of a directory on a Linux system, we use the ls
command which lists information about the files in the current
location.
README.txtThe macOS terminal is very similar to the Linux one. To show the
contents of a directory on a Linux system, we use the ls
command which lists information about the files in the current
@@ -4317,7 +4317,7 @@
When using shell commands, we use the words option, flag, and arguments to describe @@ -4346,7 +4346,7 @@
In the Windows command line, we use the /? argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the dir
@@ -4381,7 +4381,7 @@
In the Linux command line, we use the --help argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the ls
@@ -4410,7 +4410,7 @@
In the macOS command line, we use the --help argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the ls
@@ -4498,7 +4498,7 @@
This is a mechanism that tells Python how we want users to interact with our software.
@@ -4543,7 +4543,7 @@When you run the python -m oddsong command, Python runs
the main module as a script.
When we run our script as before, it will run like normal with no change in behaviour.
@@ -4713,7 +4713,7 @@The code now looks something like that shown below.
We can achieve this in our example script by adding a
help string.
We define the description when creating our argument parser object.
diff --git a/cli.html b/cli.html index 8ea5139..e1bdb39 100644 --- a/cli.html +++ b/cli.html @@ -445,7 +445,7 @@On Windows operating systems, press the Windows key and type in “command”. The start menu will find the “Command Prompt” app. Press Enter or click on the Command Prompt icon to launch the @@ -465,7 +465,7 @@
On Ubuntu, press Ctrl + Alt + T to open a terminal.
You can also open Dash and search for “Terminal”. For detailed
instructions, please read Opening
@@ -480,7 +480,7 @@ BASH
bob@myUbuntuPC:~$
Please read Open or quit Terminal on Mac on the Terminal User Guide for macOS.
@@ -513,7 +513,7 @@On Windows, the dir command is used to list the contents of a directory. When you enter this command and press Enter
@@ -543,7 +543,7 @@To show the contents of a directory on a Linux system, we use the ls
command which lists information about the files in the current
location.
README.txtThe macOS terminal is very similar to the Linux one. To show the
contents of a directory on a Linux system, we use the ls
command which lists information about the files in the current
@@ -592,7 +592,7 @@
When using shell commands, we use the words option, flag, and arguments to describe @@ -621,7 +621,7 @@
In the Windows command line, we use the /? argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the dir
@@ -656,7 +656,7 @@
In the Linux command line, we use the --help argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the ls
@@ -685,7 +685,7 @@
In the macOS command line, we use the --help argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the ls
@@ -764,7 +764,7 @@
This is a mechanism that tells Python how we want users to interact with our software.
@@ -809,7 +809,7 @@When you run the python -m oddsong command, Python runs
the main module as a script.
When we run our script as before, it will run like normal with no change in behaviour.
@@ -976,7 +976,7 @@The code now looks something like that shown below.
We can achieve this in our example script by adding a
help string.
We define the description when creating our argument parser object.
diff --git a/instructor/aio.html b/instructor/aio.html index 42eed88..b1780e2 100644 --- a/instructor/aio.html +++ b/instructor/aio.html @@ -895,7 +895,7 @@Follow these general steps to create a README file. The specific details for each operating system are detailed below.
@@ -925,7 +925,7 @@Use the File
Manager to create a new directory called oddsong.
Inside that folder, create a new text file called
@@ -952,7 +952,7 @@
Use the Finder
file manager to create a new directory called oddsong.
Inside that folder, create a new text file called
@@ -1164,7 +1164,7 @@
For more information on this topic, please see the following resources:
@@ -1201,7 +1201,7 @@A markup language is a system of special characters that are used to @@ -1236,7 +1236,7 @@
Follow these steps to rename README.txt to
README.md.
Use File
Explorer to rename
the file from README.txt to README.md.
README.md.Use the File
Manager to rename
the file from README.txt to README.md.
mv README.txt README.md
Use the Finder
to rename
the file from README.txt to README.md.
We can create the commonly-used headers used in READMEs by using the Markdown syntax shown below
@@ -1472,7 +1472,7 @@The Markdown syntax for bold font is to wrap the text in two
asterixes **. This may be applied to single words or to
@@ -2462,7 +2462,7 @@
Without syntax highlighting:
Classes use capitalised words, where each word in a phrase starts with an upper-case letter and there are no spaces between them.
Classes use capitalised words
Python comments
start with a hash character (#) and are ignored when the
code runs.
+= in the documentation for that
programming language.
Python comments
start with a hash character (#) and are ignored when the
code runs.
In the Python programming language, we can tell the user what type of
data we expect each variable to contain by using the syntax below. This
colon means that the age variable should contain a value
@@ -2902,7 +2902,7 @@
There is no type hinting feature in base R, although some packages
are available that enable this. Here, the L symbol at the
end of the number tells the R interpreter that this is an integer data
@@ -2941,7 +2941,7 @@
Below is the source code for a simple R function that calculates the sum of two numbers.
In R, there is no inbuilt functionality for annotating the expected @@ -3017,7 +3017,7 @@
None of these code examples will cause an error because type hints are just passive labels that document our code. They @@ -3922,7 +3922,7 @@
The Python code uses sys.path,
a list of locations to search for code. By modifying the Python
@@ -3953,7 +3953,7 @@
This reStructuredText (reST) markup language has the following elements:
@@ -4177,7 +4177,7 @@On Windows operating systems, press the Windows key and type in “command”. The start menu will find the “Command Prompt” app. Press Enter or click on the Command Prompt icon to launch the @@ -4197,7 +4197,7 @@
On Ubuntu, press Ctrl + Alt + T to open a terminal.
You can also open Dash and search for “Terminal”. For detailed
instructions, please read Opening
@@ -4212,7 +4212,7 @@ BASH
bob@myUbuntuPC:~$
Please read Open or quit Terminal on Mac on the Terminal User Guide for macOS.
@@ -4246,7 +4246,7 @@On Windows, the dir command is used to list the contents of a directory. When you enter this command and press Enter
@@ -4276,7 +4276,7 @@To show the contents of a directory on a Linux system, we use the ls
command which lists information about the files in the current
location.
README.txtThe macOS terminal is very similar to the Linux one. To show the
contents of a directory on a Linux system, we use the ls
command which lists information about the files in the current
@@ -4326,7 +4326,7 @@
When using shell commands, we use the words option, flag, and arguments to describe @@ -4355,7 +4355,7 @@
In the Windows command line, we use the /? argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the dir
@@ -4390,7 +4390,7 @@
In the Linux command line, we use the --help argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the ls
@@ -4419,7 +4419,7 @@
In the macOS command line, we use the --help argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the ls
@@ -4507,7 +4507,7 @@
This is a mechanism that tells Python how we want users to interact with our software.
@@ -4552,7 +4552,7 @@When you run the python -m oddsong command, Python runs
the main module as a script.
When we run our script as before, it will run like normal with no change in behaviour.
@@ -4722,7 +4722,7 @@The code now looks something like that shown below.
We can achieve this in our example script by adding a
help string.
We define the description when creating our argument parser object.
diff --git a/instructor/cli.html b/instructor/cli.html index eb29678..7f5aa47 100644 --- a/instructor/cli.html +++ b/instructor/cli.html @@ -447,7 +447,7 @@On Windows operating systems, press the Windows key and type in “command”. The start menu will find the “Command Prompt” app. Press Enter or click on the Command Prompt icon to launch the @@ -467,7 +467,7 @@
On Ubuntu, press Ctrl + Alt + T to open a terminal.
You can also open Dash and search for “Terminal”. For detailed
instructions, please read Opening
@@ -482,7 +482,7 @@ BASH
bob@myUbuntuPC:~$
Please read Open or quit Terminal on Mac on the Terminal User Guide for macOS.
@@ -515,7 +515,7 @@On Windows, the dir command is used to list the contents of a directory. When you enter this command and press Enter
@@ -545,7 +545,7 @@To show the contents of a directory on a Linux system, we use the ls
command which lists information about the files in the current
location.
README.txtThe macOS terminal is very similar to the Linux one. To show the
contents of a directory on a Linux system, we use the ls
command which lists information about the files in the current
@@ -594,7 +594,7 @@
When using shell commands, we use the words option, flag, and arguments to describe @@ -623,7 +623,7 @@
In the Windows command line, we use the /? argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the dir
@@ -658,7 +658,7 @@
In the Linux command line, we use the --help argument to
instruct the computer to print the help information that that command.
To see helpful reference information for using the ls
@@ -687,7 +687,7 @@