Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fix Sphinx errors #6369

Merged
merged 1 commit into from
Aug 11, 2022
Merged

docs: fix Sphinx errors #6369

merged 1 commit into from
Aug 11, 2022

Conversation

kenjis
Copy link
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
@kenjis
docs: fix duplicate object description of ...
7c12af8 
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
MGatner
MGatner approved these changes Aug 11, 2022
View reviewed changes
Copy link
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
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
Member Author

kenjis commented Aug 11, 2022 •
edited
Loading

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
@kenjis
Copy link
Member Author

kenjis commented Aug 11, 2022

It looks good!
https://codeigniter4.github.io/CodeIgniter4/libraries/email.html#CodeIgniter\Email\Email
https://codeigniter4.github.io/CodeIgniter4/database/query_builder.html#CodeIgniter\Database\BaseBuilder

Compare:
https://codeigniter4.github.io/userguide/libraries/email.html#class-reference
https://codeigniter4.github.io/userguide/database/query_builder.html#class-reference
Cannot link to the class.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MGatner MGatner MGatner approved these changes

Assignees
No one assigned
Labels
documentation Pull requests for documentation only
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kenjis @MGatner