Skip to content

What popped up while reviewing/adapting translations (smoe docs29_misc_16)#2357

Merged
hansu merged 10 commits intoLinuxCNC:2.9from
smoe:docs29_misc_16
Apr 24, 2023
Merged

What popped up while reviewing/adapting translations (smoe docs29_misc_16)#2357
hansu merged 10 commits intoLinuxCNC:2.9from
smoe:docs29_misc_16

Conversation

@smoe
Copy link
Copy Markdown
Collaborator

@smoe smoe commented Feb 21, 2023

No description provided.

@smoe smoe force-pushed the docs29_misc_16 branch 2 times, most recently from 6f4a2fa to 1291bc8 Compare March 3, 2023 02:20
@hansu
Copy link
Copy Markdown
Member

hansu commented Mar 3, 2023

@c-morley maybe it's good if you review the qtvcp-part and other parts you are maintaining?

@hansu
Copy link
Copy Markdown
Member

hansu commented Apr 6, 2023

No feedback from @c-morley so I guess the changes are ok. @smoe can you rebase to trigger a new build?

Comment thread docs/src/remap/remap.adoc Outdated

`"a message text"`::
Returning a string from a handler means 'this is an error message, abort the program'. Works like `(abort,` __<msg>__ `)`.
`"a message text"`:: Returning a string from a handler means 'this is an error message, abort the program'. Works like `(abort,` __<msg>__ `)`.
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.

"a message text" or `a message text` but both seems a bit duplicated

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.

Changed to a message text:: . Have not rebased, yet.

@smoe smoe force-pushed the docs29_misc_16 branch from a2995f9 to 73215be Compare April 6, 2023 12:12
Comment thread docs/src/remap/remap.adoc
Comment on lines +2202 to +2205
=== How `T`__x__ (Prepare Tool) works

[[remap:interpreter-action-on-t]]
.Interpreter action on a Tx command
.Interpreter action on a `T`__x__ command
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.

IMHO monospace font in headings and sub-headings looks ugly. Anyone who agree/disagree?

grafik

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.

I find it looks very nice.

Copy link
Copy Markdown
Collaborator

@andypugh andypugh left a comment

Choose a reason for hiding this comment

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

Approved, if you think it is good to go.

Comment thread docs/src/remap/remap.adoc Outdated
net tool-change-loop iocontrol.0.tool-change iocontrol.0.tool-changed
---------------------------------------------------------------------
If you for some reason want to remap `Tx` (prepare), the corresponding `iocontrol` pins need to be looped as well.
If you for some reason want to remap `T`__x__ (prepare), the corresponding `iocontrol` pins need to be looped as well.
Copy link
Copy Markdown
Member

@hansu hansu Apr 8, 2023

Choose a reason for hiding this comment

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

Not formatted correctly.

Comment thread docs/src/plasma/qtplasmac.adoc Outdated
If cutting a hole requires a reduced velocity then the user would use the following command to set the velocity:
*M67 E3 Qnn* where nn is the percentage of the velocity desired.
For example, *M67 E3 Q60* would set the velocity to 60% of the current material's *CutFeedRate*.
`M67 E3 Q`__nn__ where _nn_ is the percentage of the velocity desired.
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.

Also here not formatted correctly.

Comment thread docs/src/remap/remap.adoc Outdated
`argspec=`__<words>__ `ngc=`__<procname>__ `modalgroup=`___<group>__::
The recommended way to call an NGC procedure with a standard argspec parameter conversion.
Used if argspec is good enough. Note it's not good enough for remapping the `Tx` and `M6`/`M61` tool change codes.
Used if argspec is good enough. Note it's not good enough for remapping the `T`__x__ and `M6`/`M61` tool change codes.
Copy link
Copy Markdown
Member

@hansu hansu Apr 8, 2023

Choose a reason for hiding this comment

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

Not formatted correctly. But weird that exactly this works in headings.

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.

The Tx is wrong since "Tx" is not a command. I would even consider it a grave (a semantic) mistake in the documentation that needs to be fixed. Tx is what I would like to see without that nasty wide separation, but have no idea how to get there.

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.

Tx is what I would like to see without that nasty wide separation, but have no idea how to get there.

AFAIK there is no way using a syntax that is compatible with our current asciidoc version and also with the current version.
So I suggest to abstain from changes like that until we have migrated to the current asciidoctor version.

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.

We were discussing the asciidoctor migration somewhere. But yes, I should refrain from anything like that for now.

@SebKuzminsky
Copy link
Copy Markdown
Collaborator

What's the status of this PR? Can it be merged, or closed?

@hansu
Copy link
Copy Markdown
Member

hansu commented Apr 23, 2023

There are some formattings which are not compatible with our asciidoc version. So I would suggest to change that accordingly.

@hansu
Copy link
Copy Markdown
Member

hansu commented Apr 24, 2023

I took the freedom and fixed some formattings and rebased to resolve the merge conflict.

@hansu hansu merged commit 1a7e06e into LinuxCNC:2.9 Apr 24, 2023
@smoe smoe deleted the docs29_misc_16 branch April 25, 2023 04:44
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.

4 participants