fixed ide vs. IDE glossary entry

Author: thomasWeise

bookbase

@@ -12,8 +12,8 @@
 You want an editor where you can also directly execute and test your programs.
 In software development, you often work with a \pgls{vcs} like \git.
 You want to do that convenient from your editor.
-Such an editor, which integrates many of the common tasks that occur during programming, is called an \pgls{IDE}.
-In this book, we will use the \pycharm\ \pgls{IDE}~\cite{VHN2023HOADWP,Y2022PPADT}.
+Such an editor, which integrates many of the common tasks that occur during programming, is called an \pgls{ide}.
+In this book, we will use the \pycharm\ \pgls{ide}~\cite{VHN2023HOADWP,Y2022PPADT}.
 If you do not yet have \pycharm\ installed, then you can work through the setup instructions outlined in \cref{sec:installingPyCharm}.
 
 Before we get into these necessary installation and setup steps that we need to really learn programming, we face a small problem:

text/main/basics/gettingStarted/gettingStarted.tex

@@ -5,7 +5,7 @@
 Well, it is enough for just running \python\ programs.
 But it is not enough if you want to develop software efficiently.
 Are you going to write programs in a simple text editor like a caveperson?
-No, of course not, you need an \pgls{IDE}, a program which allows you to do multiple of the necessary tasks involved in the software development process under one convenient user interface.
+No, of course not, you need an \pgls{ide}, a program which allows you to do multiple of the necessary tasks involved in the software development process under one convenient user interface.
 For this book, I recommend using \pycharm, whose community edition is freely available.
 The installation guide for \pycharm\ can be found at \url{https://www.jetbrains.com/help/pycharm/installation-guide.html}.%
 %

text/main/basics/gettingStarted/installingPyCharm/installingPyCharm.tex

@@ -156,7 +156,7 @@
 As \cref{fig:installingPyCharmWindows09installation,fig:installingPyCharmWindows10installation,fig:installingPyCharmWindows11installation} show, the installation setup process is more or less automated, we just need to click \keys{Next} here and there and finally click \keys{Install}~(\cref{fig:installingPyCharmWindows12installation}).
 After the installation completes, we run \pycharm\ for the first time.
 Now we need to agree to the user agreement~(\cref{fig:installingPyCharmWindows16running}) and should probably choose that we do not with to send any information about our \pycharm\ usage out~(\cref{fig:installingPyCharmWindows17running}).
-Finally, as sketched in \cref{fig:installingPyCharmWindows18running}, we have a running and ready \pycharm\ \pgls{IDE}.%
+Finally, as sketched in \cref{fig:installingPyCharmWindows18running}, we have a running and ready \pycharm\ \pgls{ide}.%
 %
 \FloatBarrier%
 \endhsection%

text/main/basics/gettingStarted/installingPyCharm/installingPyCharmWindows/installingPyCharmWindows.tex

@@ -124,7 +124,7 @@
 %
 \begin{enumerate}%
 %
-\item We can enter the program into a \python\ file in the \pycharm\ \pgls{IDE} and then run it from there. %
+\item We can enter the program into a \python\ file in the \pycharm\ \pgls{ide} and then run it from there. %
 We just did this in the previous section and illustrated it in \cref{fig:veryFirstProgramC}.%
 %
 \item Actually, we can also write a \python\ program with a normal text editor. %

text/main/basics/gettingStarted/pythonInTheTerminal/pythonInTheTerminal.tex

@@ -1,7 +1,7 @@
 \hsection{Summary}%
 %
 In this introductory section, we have performed the very first steps into the domain of \python\ programming.
-We have now a computer where both \python\ and the \pycharm\ \pgls{IDE} are installed.
+We have now a computer where both \python\ and the \pycharm\ \pgls{ide} are installed.
 We can create program files and we can execute them in different ways.
 We also obtained the set of example programs that will later be used in this book.
 We are now ready to learn how to program.%

text/main/basics/gettingStarted/summary/summary.tex

@@ -1,6 +1,6 @@
 \hsection{Introduction}%
 %
-We now know how to create and run \python\ programs, both in the \pgls{IDE} and \pgls{terminal}.
+We now know how to create and run \python\ programs, both in the \pgls{ide} and \pgls{terminal}.
 We have also already learned our first two \python\ commands:%
 %
 \begin{itemize}%

text/main/basics/simpleDataTypesAndOperations/introduction/introduction.tex

@@ -8,7 +8,7 @@
 \centering%
 %
 \subfloat[][%
-We run the program \textil{assignment_wrong.py} given in \cref{lst:variables:assignment_wrong} in the \pycharm\ \pgls{IDE} by clicking on the \pycharmRun\ button or by pressing~\keys{\shift+F10}.%
+We run the program \textil{assignment_wrong.py} given in \cref{lst:variables:assignment_wrong} in the \pycharm\ \pgls{ide} by clicking on the \pycharmRun\ button or by pressing~\keys{\shift+F10}.%
 \label{fig:errorsInIde01runProgram}%
 ]{\tightbox{\includegraphics[width=0.9\linewidth]{\currentDir/errorsInIde01runProgram}}}%
 %
@@ -32,7 +32,7 @@
 \label{fig:errorsInIde03underlined}%
 ]{\tightbox{\includegraphics[width=0.9\linewidth]{\currentDir/errorsInIde03underlined}}}%
 %
-\caption{How the \pgls{IDE} can help us finding errors.}%
+\caption{How the \pgls{ide} can help us finding errors.}%
 \label{fig:errorsInIdeA}%
 \end{figure}%
 %
@@ -41,7 +41,7 @@
 \centering%
 %
 \subfloat[][%
-The \pgls{IDE} also informs us that something is wrong by displaying the small red~\pycharmErrorsSymbol~icon in the top-right corner. %
+The \pgls{ide} also informs us that something is wrong by displaying the small red~\pycharmErrorsSymbol~icon in the top-right corner. %
 This is the \emph{third} way to find errors. %
 We click on it\dots%
 \label{fig:errorsInIde04errors}%
@@ -64,7 +64,7 @@
 \label{fig:errorsInIde06errorsListToLine}%
 ]{\tightbox{\includegraphics[width=0.9\linewidth]{\currentDir/errorsInIde06errorsListToLine}}}%
 %
-\caption{How the \pgls{IDE} can help us finding errors.}%
+\caption{How the \pgls{ide} can help us finding errors.}%
 \label{fig:errorsInIdeB}%
 \end{figure}%
 %
@@ -73,7 +73,7 @@
 \centering%
 %
 \subfloat[][%
-The \emph{fourth} way in which the \pycharm\ \pgls{IDE} can help us to discover errors are small red marks at the right-hand side. %
+The \emph{fourth} way in which the \pycharm\ \pgls{ide} can help us to discover errors are small red marks at the right-hand side. %
 Holding the mouse cursor over these lines will open a small view with the suggested error message.%
 \label{fig:errorsInIde07errorMark}%
 ]{\tightbox{\includegraphics[width=0.9\linewidth]{\currentDir/errorsInIde07errorMark}}}%
@@ -92,29 +92,29 @@
 \label{fig:errorsInIde09sidebarToView}%
 ]{\tightbox{\includegraphics[width=0.9\linewidth]{\currentDir/errorsInIde09sidebarToView}}}%
 %
-\caption{How the \pgls{IDE} can help us finding errors.}%
+\caption{How the \pgls{ide} can help us finding errors.}%
 \label{fig:errorsInIdeC}%
 \end{figure}%
 %
-Before we depart from \pycharm\ screenshots, however, we will visit one absolutely crucial functionality that modern \pglspl{IDE} provide:
+Before we depart from \pycharm\ screenshots, however, we will visit one absolutely crucial functionality that modern \pglspl{ide} provide:
 They help us to find errors in the code.
 Errors are common.
 They happen all the time.
 Every programmer sometimes makes a typo, accidentally switches the order of parameters of a function, stores a \pythonil{float} in an \pythonil{int} variable, and so on.
 Some errors are obvious and easy to fix.
 Some require more serious debugging (see \cref{sec:dunder:debugging}).
-In many cases, however, our \pgls{IDE} can already show us what and where the mistake happened.
+In many cases, however, our \pgls{ide} can already show us what and where the mistake happened.
 
 In \cref{lst:variables:assignment_wrong}, we prepared program \textil{assignment_wrong.py}, a variant of \textil{assignment.py}~(\cref{lst:variables:assignment}) with an error.
 For the sake of the example, let us assume that the programmer made a type in line~12 of the program:
 They misspelled \pythonil{int_var} and \pythonil{intvar}.
 Executing the program with the error leads to the output given in \cref{exec:variables:assignment_wrong}.
 
 The questions now are:
-How can we see this same error in our \pycharm\ \pgls{IDE}?
+How can we see this same error in our \pycharm\ \pgls{ide}?
 Could we have found this error even without executing the program?
 
-To answer these questions, we open the program \textil{assignment_wrong.py} given in \cref{lst:variables:assignment_wrong} in the \pycharm\ \pgls{IDE}.
+To answer these questions, we open the program \textil{assignment_wrong.py} given in \cref{lst:variables:assignment_wrong} in the \pycharm\ \pgls{ide}.
 We execute this program manually by clicking on the \pycharmRun\ button or by pressing~\keys{\shift+F10} in \cref{fig:errorsInIde01runProgram}.
 As you can see, the output in the run window is the same as given in \cref{exec:variables:assignment_wrong}~(\cref{fig:errorsInIde02exception}).
 Reading this output is the \emph{first} way to find out what went wrong.
@@ -141,41 +141,41 @@
 This should have told us already that something is fishy without the need to even run the program in the first place.%
 %
 \bestPractice{redUnderline}{%
-When writing code, we should always check whether the \pgls{IDE} notifies us about potential errors. %
+When writing code, we should always check whether the \pgls{ide} notifies us about potential errors. %
 In the case of \pycharm, these are often underlined in red or yellow color. %
 We should always check all such marks!%
 }%
 %
-So we already know two ways in which we can find errors in our code with the help of our \pgls{IDE}.
+So we already know two ways in which we can find errors in our code with the help of our \pgls{ide}.
 But there are even more ways.
 
-The \pgls{IDE} also informs us that something is wrong by displaying the small red~\pycharmErrorsSymbol~icon in the top-right corner, as shown in \cref{fig:errorsInIde04errors}.
+The \pgls{ide} also informs us that something is wrong by displaying the small red~\pycharmErrorsSymbol~icon in the top-right corner, as shown in \cref{fig:errorsInIde04errors}.
 Clicking on this symbol is the third way to find errors.
 This will take us to the list of potential errors that it has detected in \cref{fig:errorsInIde05errorsList}.
 Here, \pycharm\ tells us that there is an \emph{\inQuotes{Unresolved reference \inSQuotes{intvar}}} at line~12 of the file.
 We can also click on that note, and  it takes us again to the dodgy line in \cref{fig:errorsInIde06errorsListToLine}
 
-The fourth method in which the \pycharm\ \pgls{IDE} can help us to discover errors are small red marks at the right-hand side of our editor window, shown in \cref{fig:errorsInIde07errorMark}.
+The fourth method in which the \pycharm\ \pgls{ide} can help us to discover errors are small red marks at the right-hand side of our editor window, shown in \cref{fig:errorsInIde07errorMark}.
 Holding the mouse cursor over these lines will open a small view with the suggested error message.
 
 The fifth way to get a list of potential errors in \pycharm\ is to click on the \pycharmErrorsButton~button in the side menu on the left-hand side or to press~\keys{\Alt+6}, as illustrated in \cref{fig:errorsInIde08sidebar}.
 This again takes us to the list of potential errors in \cref{fig:errorsInIde09sidebarToView}.
 %
 \usefulTool{ideForErrors}{%
-The \pgls{IDE} and the error messages (\pythonilIdx{Exception} \pglspl{stackTrace}) are your most important tools to find errors. %
+The \pgls{ide} and the error messages (\pythonilIdx{Exception} \pglspl{stackTrace}) are your most important tools to find errors. %
 Read error messages. %
-If your \pgls{IDE}  -- regardless whether it is \pycharm\ or something else -- annotates your code with some marks, then you should check every single one of them.%
+If your \pgls{ide}  -- regardless whether it is \pycharm\ or something else -- annotates your code with some marks, then you should check every single one of them.%
 }%
 %
 These tools make it much much easier to find errors.
 You can guess the importance of such features also by how many different ways \pycharm\ implements to get you to click and investigate its list of proposed errors and warnings.
-As mentioned in \cref{bp:readErrorMessage,bp:redUnderline}, using the \pgls{IDE} features for error discovery and detection is incredibly important.
+As mentioned in \cref{bp:readErrorMessage,bp:redUnderline}, using the \pgls{ide} features for error discovery and detection is incredibly important.
 Even if your program executes as expected, there still might be hidden errors in the code.
 Sometimes, you cannot easily tell whether the output of a program is correct.
 And the output you see might actually be wrong.
 Sometimes, there might be some incorrect instructions in your program that just weren't used in your last execution.
 So even correct program output does not guarantee that the program itself is correct.
-Therefore, always checking each and every piece of code that your \pgls{IDE} marks as dodgy is very important.
+Therefore, always checking each and every piece of code that your \pgls{ide} marks as dodgy is very important.
 Make sure that you full understand all error and warning messages.
 
 Warnings can be important, too.

text/main/basics/variables/errorsInIde/errorsInIde.tex

@@ -245,10 +245,10 @@
 \gitOutputTool{\programmingWithPythonCodeRepo}{.}{_scripts_/mypy.sh variables assignment_wrong.py}{variables:assignment_wrong:mypy}{%
 The results of static type checking the program \textil{assignment_wrong.py} with \mypy\ given in \cref{lst:variables:assignment_wrong}.}%
 %
-For the sake of completeness, we also apply \mypy\ to the program \textil{assignment_wrong} given in \cref{lst:variables:assignment_wrong} that we used to illustrate the use of the \pycharm\ \pgls{IDE} in finding bugs.
+For the sake of completeness, we also apply \mypy\ to the program \textil{assignment_wrong} given in \cref{lst:variables:assignment_wrong} that we used to illustrate the use of the \pycharm\ \pgls{ide} in finding bugs.
 The output given in \cref{exec:variables:assignment_wrong:mypy} informs us about the same error we encountered back in \cref{sec:errorsInIde}:
 \emph{\inQuotes{Name \inQuotes{intvar} is not defined.}}
-With the \pgls{IDE} and \mypy, we now have independent tools that can help us to discover errors in our code.
+With the \pgls{ide} and \mypy, we now have independent tools that can help us to discover errors in our code.
 The more such tools we have \emph{and actively use}, the more likely it is that we can produce error-free programs.
 
 You may ask why we emphasize that \pglspl{typeHint} are important and good for a programming language where they are originally not part of.

text/main/basics/variables/typesAndTypeHints/typesAndTypeHints.tex

@@ -717,7 +717,7 @@
 With a tool called \debugger\ which ships with \python\ and \pycharm.%
 %
 \usefulTool{debugger}{%
-A \debugger\ is a tool that ships with many programming languages and \pglspl{IDE}. %
+A \debugger\ is a tool that ships with many programming languages and \pglspl{ide}. %
 It allows you to execute a program step-by-step while observing the current values of variables. %
 This way, you can find errors in the code more easily~\cite{W2024PME,A2002D,R2007PPBPDTAM}. %
 A comprehensive example on how to use the \debugger\ in \pycharm\ is given in~\cref{sec:dunder:debugging}.%
@@ -780,7 +780,7 @@
 
 On the left side of our code file, there is a column with the line numbers.
 We can left-click on a line to place a \pgls{breakpoint} there.
-A \pgls{breakpoint} is a mark in the \pgls{IDE} at which we later want the program execution to pause.
+A \pgls{breakpoint} is a mark in the \pgls{ide} at which we later want the program execution to pause.
 We want our program to pause right at the beginning of \pythonil{decimal_str}, so be place the \pgls{breakpoint} there~(\cref{fig:dunder:debug02}).
 The \pgls{breakpoint} is shown as a red ball over the line number.
 

text/main/classes/dunder/dunder.tex

@@ -370,7 +370,7 @@
 
 Indeed: If we look at the \textil{.venv} directory in the directory view, we cannot find the \psycopg\ package.
 Currently, this directory only contains the \pip\ package in \cref{fig:gitClonePycharm17packageMissing}.
-A long time ago, back in \cref{sec:errorsInIde}, we mentioned that all warnings and errors that our development \pgls{IDE} reports to us are important and should be fixed (by us).
+A long time ago, back in \cref{sec:errorsInIde}, we mentioned that all warnings and errors that our development \pgls{ide} reports to us are important and should be fixed (by us).
 Clearly, a missing library is important, because without that package, the code we just downloaded would be useless and could not run.
 
 To remedy this issue, we click on the requirements warning in \cref{fig:gitClonePycharm18requirementsWarning}.

text/main/ecosystem/git/gitClone/gitClonePycharm/gitClonePycharm.tex

@@ -76,7 +76,7 @@
 \label{fig:venvPycharmB}%
 \end{figure}%
 %
-The \pgls{IDE} \pycharm\ also supports using \pglspl{virtualEnvironment} and \textil{requirements.txt} files.
+The \pgls{ide} \pycharm\ also supports using \pglspl{virtualEnvironment} and \textil{requirements.txt} files.
 Let us here demonstrate this on the example program that requires \numpy\ which was given as \cref{lst:packages:numpy_user} and \textil{requirements.txt} file given in \cref{lst:packages:requirementstxt}.
 In \cref{fig:venvPycharmA}, we work through the steps to create and manage a project with a \pgls{virtualEnvironment} in \pycharm\ on their basis.
 (A complete example on how to copy a source code repository from \git\ or \github\ and how to set up a \pgls{virtualEnvironment} for its dependencies is given in \cref{sec:gitClonePycharm}.)
@@ -125,11 +125,11 @@
 However, it must be understood that the support for \pglspl{virtualEnvironment} and requirements files in \pycharm\ is for \emph{software development}.
 If you want to actually use the software you have developed, you should \emph{always} use the command line and \pglspl{terminal}, as discussed in \cref{sec:pipAndVenv}.
 \pycharm\ is not a runtime environment for the deployment of productive code.
-It is an \acrfull{IDE} for developing programs.%
+It is an \acrfull{ide} for developing programs.%
 %
 \bestPractice{noPycharmForProductive}{%
 \pycharm\ must \textbf{never} be used for running an application in a productive setting. %
-It is \emph{only} to be used as \pgls{IDE} for software development. %
+It is \emph{only} to be used as \pgls{ide} for software development. %
 For actually executing programs, always use a \pglspl{virtualEnvironment} in the \pgls{terminal} as introduced in \cref{sec:pipAndVenv}. %
 See also \cref{bp:runningProgram}.%
 }%