Skip to content

Ticket #3734: improve syntax documentation for mcedit#5077

Open
jip wants to merge 2 commits intoMidnightCommander:masterfrom
jip:3734-improve-syntax-doc
Open

Ticket #3734: improve syntax documentation for mcedit#5077
jip wants to merge 2 commits intoMidnightCommander:masterfrom
jip:3734-improve-syntax-doc

Conversation

@jip
Copy link
Copy Markdown

@jip jip commented Mar 23, 2026

Document text sequences interpreted by mcedit.

Proposed changes

Put a table with patterns correspondence 'mcedit vs. pcre2' from #3734 into doc/man/mcedit.1.in file.

Checklist

👉 Our coding style can be found here: https://midnight-commander.org/coding-style/ 👈

  • I have referenced the issue(s) resolved by this PR (if any)
  • I have signed-off my contribution with git commit --amend -s
  • Lint and unit tests pass locally with my changes (make indent && make check)
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)

@github-actions github-actions bot added the needs triage Needs triage by maintainers label Mar 23, 2026
@github-actions github-actions bot added this to the Future Releases milestone Mar 23, 2026
@github-actions github-actions bot added the prio: medium Has the potential to affect progress label Mar 23, 2026
@zyv zyv added area: docs Improvements or additions to documentation and removed needs triage Needs triage by maintainers labels Apr 9, 2026
@zyv zyv changed the title improve the syntax documentation for mcedit Ticket #3734: improve syntax documentation for mcedit Apr 9, 2026
@zyv
Copy link
Copy Markdown
Member

zyv commented Apr 9, 2026

@jip, thanks for working on this!

Unfortunately, you used the wrong roff syntax, so the man pages cannot be rendered correctly. Could you please fix the following roff warnings:

  • mcedit.1.in: unescaped dash ('-')
  • mcedit.1.in:483: warning: macro '@\.@' not defined
  • mcedit.1.in:497: warning: tbl preprocessor failed, or it or soelim was not run; table(s) likely not rendered (TE macro called with TW register undefined)
  • mcedit.1.in: forbidden pattern '\\'
  • mcedit.1.in: forbidden pattern '\.'

Also, please sign off your commit as instructed in the PR template.

Thank you!

@jip
Copy link
Copy Markdown
Author

jip commented Apr 10, 2026

Done.

@zyv
Copy link
Copy Markdown
Member

zyv commented Apr 10, 2026

/rebase

jip added 2 commits April 10, 2026 12:51
Document text sequences interpreted by mcedit .
Relates to MidnightCommander#3734 .

Changes to be committed:
	modified:   doc/man/mcedit.1.in
replace table .TS ... .TE by example block .EX ... .EE

Signed-off-by: Igor Zhuravlov <zhuravlov.ip@ya.ru>
@mc-butler mc-butler force-pushed the 3734-improve-syntax-doc branch from cff03df to c20d1ce Compare April 10, 2026 12:51
@zyv zyv modified the milestones: Future Releases, 4.9.0 Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Improvements or additions to documentation prio: medium Has the potential to affect progress

Development

Successfully merging this pull request may close these issues.

Improve the syntax documentation

2 participants