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: improve lang() #8836

Merged
merged 2 commits into from
Apr 30, 2024
Merged

docs: improve lang() #8836

merged 2 commits into from
Apr 30, 2024

Conversation

kenjis
Copy link
Member

@kenjis kenjis commented Apr 28, 2024

Description

  • improve descriptions

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 added the documentation Pull requests for documentation only label Apr 28, 2024
datamweb
datamweb reviewed Apr 28, 2024
View reviewed changes
user_guide_src/source/general/common_functions.rst
:param string $locale: Specify a different locale to be used instead of default one.
:param string $locale: Specify a different locale to be used instead of the current locale.
:returns: The text in the language file
:rtype: list<string>|string
Copy link
Contributor

Choose a reason for hiding this comment

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

@kenjis , is that(rtype) a typo?

Copy link
Contributor

Choose a reason for hiding this comment

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

However, I didn't see anything in documentation or sphinx. Please provide a reference link.

Copy link
Member Author

@kenjis kenjis Apr 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

No. It is for Return type:. See https://github.com/search?q=repo%3Acodeigniter4%2FCodeIgniter4%20%3Artype%3A&type=code

Copy link
Member

Choose a reason for hiding this comment

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

rtype is documented in python domain: https://www.sphinx-doc.org/en/master/usage/domains/python.html#info-field-lists

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you @michalsn .

@kenjis kenjis merged commit 8b0c99b into codeigniter4:develop Apr 30, 2024
3 checks passed
@kenjis kenjis deleted the docs-improve-lang branch April 30, 2024 00:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datamweb datamweb datamweb approved these changes

@michalsn michalsn michalsn 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.
3 participants
@kenjis @michalsn @datamweb