Skip to content

Commit

Permalink
grammar/code cleanups
Browse files Browse the repository at this point in the history
  • Loading branch information
shlomif committed Dec 22, 2024
1 parent 3508970 commit 3bda053
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 14 deletions.
13 changes: 9 additions & 4 deletions FAQ.docbook5.xml.tt2
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,7 @@ probably get more help on the topic-specific channels.
</para>
</section>
<section xml:id="what-is-the-channel-for-topictechnology">
<title>What is the channel for
<emphasis>T</emphasis><emphasis>O</emphasis><emphasis>P</emphasis><emphasis>I</emphasis><emphasis>C</emphasis>/TECHNOLOGY?</title>
<title>What is the channel for a certain topic or technology?</title>
<para>
You can search the channels list by following the instructions
in the command <literal>/msg alis help</literal> .
Expand Down Expand Up @@ -174,6 +173,7 @@ So please
programming properly</link> .
</para>
</section>

<section xml:id="how-should-i-ask-a-question-on-the-channel-can-i">
<title>How should I ask a question on the channel? Can
I?</title>
Expand Down Expand Up @@ -293,7 +293,7 @@ Nano</link>, should be OK.
</listitem>
</itemizedlist>
<para>
These editors may still be useful if that's all you can use,
These editors may still be useful if they are all you can use,
but if you can afford to install and/or use a more capable
text editor, it is, by all means, a good idea.
</para>
Expand Down Expand Up @@ -337,6 +337,7 @@ Linux/UNIX). As a result, there is no good excuse not to
download one, install it, and use it.
</para>
</section>

<section xml:id="i-want-to-learn-programming-which-language-should-i-start-with">
<title>I want to learn programming? Which language should I
start with?</title>
Expand Down Expand Up @@ -459,6 +460,7 @@ ones, and generally waste the time of the more experienced
people on the channel who are trying to help you.
</para>
</section>

<section xml:id="how-do-i-learn-how-to-program">
<title>How do I learn how to program?</title>
<para>
Expand All @@ -467,6 +469,7 @@ See the
question</link>.
</para>
</section>

<section xml:id="how-should-i-do-binary-inputoutput-properly">
<title>How should I do binary Input/Output properly?</title>
<para>
Expand Down Expand Up @@ -519,6 +522,7 @@ should be able to find some mechanisms inside
libraries</link> to do that.
</para>
</section>

<section xml:id="what-are-some-best-practices-in-programming-that-i-should-adopt">
<title>What are some best practices in programming that I should
adopt?</title>
Expand Down Expand Up @@ -554,7 +558,7 @@ As of 2024, <link xlink:href="https://en.wikipedia.org/wiki/Git">the Git version
<itemizedlist spacing="compact">
<listitem>
<para>
Please don't give the usual cliches that you don't need a
Please don't give the usual clichés that you don't need a
version control system if you’re only one person or that
the project is not large enough to warrant it. You
probably do.
Expand Down Expand Up @@ -728,6 +732,7 @@ Koponen.
</listitem>
</orderedlist>
</section>

<section xml:id="what-is-the-best-programming-language">
<title>What is the best programming language?</title>
<para>
Expand Down
10 changes: 5 additions & 5 deletions FAQ.mdwn
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Note that you are still welcome to ask questions related to specific
technologies on \##programming, but otherwise you'll probably get more
help on the topic-specific channels.

### What is the channel for *TOPIC*/TECHNOLOGY?
### What is the channel for a certain topic or technology?

You can search the channels list by following the instructions in the
command `/msg alis help` .
Expand Down Expand Up @@ -168,9 +168,9 @@ adequate for editing code:
[Notepad2](http://www.flos-freeware.ch/notepad2.html) and [GNU
Nano](http://www.nano-editor.org/), should be OK.

These editors may still be useful if that's all you can use, but if you
can afford to install and/or use a more capable text editor, it is, by
all means, a good idea.
These editors may still be useful if they are all you can use, but if
you can afford to install and/or use a more capable text editor, it is,
by all means, a good idea.

Otherwise, asking the channel about the most recommend text editor will
end up in people giving you their own preferences (which may have
Expand Down Expand Up @@ -307,7 +307,7 @@ But here goes with a grain of salt:
enough](https://www.shlomifish.org/humour/fortunes/show.cgi?id=sharp-programming-BitKeeper-or-GitHub)
to avoid using any-of-the-semingly-less-popular alternatives.

- Please don't give the usual cliches that you don't need a version
- Please don't give the usual clichés that you don't need a version
control system if you’re only one person or that the project is not
large enough to warrant it. You probably do.

Expand Down
10 changes: 5 additions & 5 deletions FAQ_with_ToC__generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Note that you are still welcome to ask questions related to specific
technologies on \##programming, but otherwise you'll probably get more
help on the topic-specific channels.

### What is the channel for *TOPIC*/TECHNOLOGY?
### What is the channel for a certain topic or technology?

You can search the channels list by following the instructions in the
command `/msg alis help` .
Expand Down Expand Up @@ -259,9 +259,9 @@ adequate for editing code:
[Notepad2](http://www.flos-freeware.ch/notepad2.html) and [GNU
Nano](http://www.nano-editor.org/), should be OK.

These editors may still be useful if that's all you can use, but if you
can afford to install and/or use a more capable text editor, it is, by
all means, a good idea.
These editors may still be useful if they are all you can use, but if
you can afford to install and/or use a more capable text editor, it is,
by all means, a good idea.

Otherwise, asking the channel about the most recommend text editor will
end up in people giving you their own preferences (which may have
Expand Down Expand Up @@ -398,7 +398,7 @@ But here goes with a grain of salt:
enough](https://www.shlomifish.org/humour/fortunes/show.cgi?id=sharp-programming-BitKeeper-or-GitHub)
to avoid using any-of-the-semingly-less-popular alternatives.

- Please don't give the usual cliches that you don't need a version
- Please don't give the usual clichés that you don't need a version
control system if you’re only one person or that the project is not
large enough to warrant it. You probably do.

Expand Down

0 comments on commit 3bda053

Please sign in to comment.