Skip to content

docs: fix Sphinx errors#6369

Merged
kenjis merged 1 commit intocodeigniter4:developfrom
kenjis:fix-docs-sphinx-errors
Aug 11, 2022
Merged

docs: fix Sphinx errors#6369
kenjis merged 1 commit intocodeigniter4:developfrom
kenjis:fix-docs-sphinx-errors

Conversation

@kenjis
Copy link
Copy Markdown
Member

@kenjis kenjis commented Aug 11, 2022

Description

  • fix Sphinx errors

Checklist:

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

@kenjis kenjis marked this pull request as draft August 11, 2022 09:54
@kenjis kenjis added the documentation Pull requests for documentation only label Aug 11, 2022
@kenjis kenjis marked this pull request as ready for review August 11, 2022 10:48
@kenjis kenjis marked this pull request as draft August 11, 2022 10:56
E.g.,
Check User Guide syntax: user_guide_src/source/libraries/caching.rst#L182
duplicate object description of increment, other instance in /github/workspace/user_guide_src/source/database/query_builder.rst
@kenjis kenjis force-pushed the fix-docs-sphinx-errors branch from c516607 to 7c12af8 Compare August 11, 2022 11:02
Copy link
Copy Markdown
Member

@MGatner MGatner left a comment

Choose a reason for hiding this comment

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

I'm not that familiar with Sphinx and syntax but I trust you to proceed if these changes are all fixes.

@MGatner
Copy link
Copy Markdown
Member

MGatner commented Aug 11, 2022

If you want a better review I think @paulbalandan has some Sphinx experience.

@kenjis kenjis marked this pull request as ready for review August 11, 2022 11:41
@kenjis
Copy link
Copy Markdown
Member Author

kenjis commented Aug 11, 2022

Now "Test User Guide" check fails. See #6368
https://github.com/codeigniter4/CodeIgniter4/runs/7784160957?check_suite_focus=true
This PR fixes the errors.

I also think the way in this PR is the correct way to describe FQCN.

@kenjis kenjis merged commit 6d3a24b into codeigniter4:develop Aug 11, 2022
@kenjis kenjis deleted the fix-docs-sphinx-errors branch August 11, 2022 11:48
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