Skip to content

Docs stupid simple stuff#1923

Merged
hansu merged 6 commits intoLinuxCNC:masterfrom
smoe:docs_stupid_simple_stuff
Aug 16, 2022
Merged

Docs stupid simple stuff#1923
hansu merged 6 commits intoLinuxCNC:masterfrom
smoe:docs_stupid_simple_stuff

Conversation

@smoe
Copy link
Copy Markdown
Collaborator

@smoe smoe commented Aug 14, 2022

No description provided.

Comment thread docs/src/plasma/qtplasmac.adoc Outdated
Comment thread docs/src/plasma/qtplasmac.adoc Outdated
Comment thread docs/src/gui/gladevcp.adoc Outdated
Comment thread docs/src/gui/gladevcp.adoc Outdated
=== Embedding as a Tab

To do so, edit your .ini file and add to the DISPLAY and HAL sections of INI
To do so, edit your .ini (INI) file and add to the DISPLAY and HAL sections of INI
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To do so, edit your .ini (INI) file and add to the DISPLAY and HAL sections of INI
To do so, edit your INI file and add to the DISPLAY and HAL sections of INI

to have it consistent

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At some point you need to introduce that .ini and INI files are the same thing.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then it should be introduced in every document where "INI file" and similar is used. But that should be clear to people who can operate a pc, that an INi file is a file with the extension "ini".
Even in https://linuxcnc.org/docs/devel/html/config/ini-config.html it is not mentioned, that it is a file with .ini extension...

@petterreinholdtsen
Copy link
Copy Markdown
Collaborator

This change look good, and I believe it should go in as soon as the two typos are fixed.

@smoe smoe force-pushed the docs_stupid_simple_stuff branch from f7c5dec to f661ec4 Compare August 15, 2022 00:37
@smoe
Copy link
Copy Markdown
Collaborator Author

smoe commented Aug 15, 2022

I would prefer adding it to the ini-config file over removing the extra clarity here. The same for HAL files.

@smoe smoe force-pushed the docs_stupid_simple_stuff branch from f661ec4 to f83d9fd Compare August 16, 2022 07:02
@smoe
Copy link
Copy Markdown
Collaborator Author

smoe commented Aug 16, 2022

I gave in - added respective patch and rebased to master.

@hansu
Copy link
Copy Markdown
Member

hansu commented Aug 16, 2022

I gave in - added respective patch and rebased to master.

As this patch is about details, we also have to speak in details 😉

If we want to explain/introduce that (what is obvious IMHO) I would suggest it this way (in general):
To do so, edit your INI file (.ini) and add to the DISPLAY and HAL sections of INI

@smoe
Copy link
Copy Markdown
Collaborator Author

smoe commented Aug 16, 2022

Except that this patch removes that detail so we do not need to talk about it - in this thread. I want to move on, please.

@hansu
Copy link
Copy Markdown
Member

hansu commented Aug 16, 2022

Sure, sorry 😇

@hansu hansu merged commit 47731ff into LinuxCNC:master Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants