Skip to content

docs: add note for custom command generator template#7408

Merged
kenjis merged 4 commits intocodeigniter4:developfrom
sammyskills:docs-update-cli-generators
Apr 7, 2023
Merged

docs: add note for custom command generator template#7408
kenjis merged 4 commits intocodeigniter4:developfrom
sammyskills:docs-update-cli-generators

Conversation

@sammyskills
Copy link
Copy Markdown
Contributor

@sammyskills sammyskills commented Apr 4, 2023

Description
Added explanation on how to locate the view template of a custom generator command. Fixes #7405.

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

Comment thread user_guide_src/source/cli/cli_generators/001.php Outdated
@sammyskills sammyskills requested a review from datamweb April 4, 2023 21:24
Copy link
Copy Markdown
Contributor

@datamweb datamweb left a comment

Choose a reason for hiding this comment

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

It does not seem correct to use "`" for these two cases.
As far as I know, "**" is used most of the time.
In any case, I did not see an explanation in documentation..

Wait for @kenjis to confirm.

Comment thread user_guide_src/source/cli/cli_generators.rst Outdated
Comment thread user_guide_src/source/cli/cli_generators.rst Outdated
@sammyskills
Copy link
Copy Markdown
Contributor Author

sammyskills commented Apr 4, 2023

Wait for @kenjis to confirm.

Ok.

@sammyskills sammyskills closed this Apr 4, 2023
@sammyskills sammyskills reopened this Apr 4, 2023
@kenjis
Copy link
Copy Markdown
Member

kenjis commented Apr 4, 2023

As a general rule, we use ** for in-line file paths, and `` for source code.

See https://github.com/codeigniter4/CodeIgniter4/blob/17287d1ad6df163ead2032e5098d1fc1cb97f19f/contributing/documentation.rst in #7410

@kenjis kenjis added the documentation Pull requests for documentation only label Apr 5, 2023
Comment thread user_guide_src/source/cli/cli_generators.rst Outdated
@sammyskills sammyskills force-pushed the docs-update-cli-generators branch from 81d7e05 to a12263b Compare April 6, 2023 10:20
@sammyskills sammyskills requested a review from paulbalandan April 6, 2023 10:25
Comment thread user_guide_src/source/cli/cli_generators.rst Outdated
Co-authored-by: John Paul E. Balandan, CPA <paulbalandan@gmail.com>
@sammyskills sammyskills requested a review from paulbalandan April 6, 2023 11:33
@kenjis kenjis merged commit e8cf06f into codeigniter4:develop Apr 7, 2023
@kenjis
Copy link
Copy Markdown
Member

kenjis commented Apr 7, 2023

Thank you all!

@sammyskills sammyskills deleted the docs-update-cli-generators branch April 7, 2023 03: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.

Bug: Generator Command cannot locate the view template.

4 participants