Skip to content

docs: fix RST markup errors in the user guide - #10668

Merged
paulbalandan merged 1 commit into
codeigniter4:developfrom
paulbalandan:user-guide-rst-markup-errors
Oct 28, 2026
Merged

paulbalandan merged 1 commit into
codeigniter4:developfrom
paulbalandan:user-guide-rst-markup-errors

Conversation

@paulbalandan

Copy link
Copy Markdown
Member

Description
Fixes RST markup errors that also render wrong in the current guide:

  • guides/first-app/news_section.rst: removes a duplicated line fragment.
  • installation/upgrade_sessions.rst and changelogs/v4.7.0.rst: removes stray backticks after inline literals, and names the method as paginate().
  • installation/upgrade_450.rst: indents the second line of list item 2, so it renders as a list item again with its examples inside it.
  • general/urls.rst: replaces a code span holding only a space with "Space character".
  • general/common_functions.rst, libraries/email.rst and installation/upgrade_4xx.rst: replaces links to hard-coded Sphinx HTML anchors with :php:func: and :php:meth: roles, so Sphinx checks them.

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication)
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@carson-codeigniter4 carson-codeigniter4 Bot added the documentation Pull requests for documentation only label Oct 27, 2026
@paulbalandan
paulbalandan merged commit f992c27 into codeigniter4:develop Oct 28, 2026
9 checks passed
@paulbalandan
paulbalandan deleted the user-guide-rst-markup-errors branch October 28, 2026 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants