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 scaffold query --help #3349

Merged
merged 23 commits into from
Oct 19, 2023
Merged

docs: improve scaffold query --help #3349

merged 23 commits into from
Oct 19, 2023

Conversation

AndrewDonelson
Copy link
Contributor

@AndrewDonelson AndrewDonelson commented Dec 30, 2022 •
edited by jeronimoalbi
Loading

Resolves #3346

Add info on referencing table

Please make sure to check the following for your PR:

  • This PR complies with the contributing guidelines.
  • Reviewed "Files changed" and left comments if necessary
  • Included relevant documentation changes.

Ignite CLI team only:

  • I have updated the Unreleased section in the changelog.md for my changes.

@AndrewDonelson AndrewDonelson changed the title Feat: issue #3346 (Updated) docs: issue #3346 (Updated) Dec 30, 2022
@jeronimoalbi
Copy link
Member

That's great @AndrewDonelson, thank you! There is a conflict that I think you can solve by updating your branch with the latest changes from main.

jeronimoalbi
jeronimoalbi reviewed Jan 6, 2023
View reviewed changes
changelog.md Outdated Show resolved Hide resolved
@jeronimoalbi jeronimoalbi changed the title docs: issue #3346 (Updated) docs: improve scaffold query --help Jan 6, 2023
@jeronimoalbi jeronimoalbi added the component:docs Documentation additions or improvements. label Jan 6, 2023
@Pantani Pantani requested a review from ilgooz as a code owner May 22, 2023 10:30
@Pantani
Copy link
Collaborator

Pantani commented Jul 19, 2023

@AndrewDonelson any update?

julienrbrt
julienrbrt requested changes Oct 16, 2023
View reviewed changes
ignite/cmd/scaffold_type.go Outdated Show resolved Hide resolved
ignite/cmd/scaffold_list.go Outdated Show resolved Hide resolved
ignite/cmd/scaffold_map.go Show resolved Hide resolved
Ehsan-saradar
Ehsan-saradar previously approved these changes Oct 18, 2023
View reviewed changes
Pantani
Pantani requested changes Oct 18, 2023
View reviewed changes
Copy link
Collaborator

@Pantani Pantani left a comment

Choose a reason for hiding this comment

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

Can you please add an Example parameter into the cobra commands for all commands?

ignite/cmd/scaffold_single.go Outdated Show resolved Hide resolved
ignite/cmd/scaffold_type.go Outdated Show resolved Hide resolved
ignite/cmd/scaffold_single.go
Short: "CRUD for data stored in a single location",
Long: `CRUD for data stored in a single location.

For detailed type information use ignite scaffold type --help.`,
Args: cobra.MinimumNArgs(1),
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you also add an example to the Example parameter?

Copy link
Contributor

Choose a reason for hiding this comment

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

Done, also do you think we need to add Example for other scaffold commands?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we can only cover these query commands in this PR and others later, wdyt?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good to me

@Pantani Pantani requested review from Ehsan-saradar and removed request for tbruyelle, fadeev, lumtis and aljo242 October 18, 2023 13:14
@Pantani Pantani requested a review from fadeev October 19, 2023 14:37
@Pantani Pantani merged commit 7436d93 into ignite:main Oct 19, 2023
@Pantani Pantani modified the milestones: v0.29, v0.28 Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Pantani Pantani Pantani approved these changes

@ilgooz ilgooz Awaiting requested review from ilgooz ilgooz is a code owner

@julienrbrt julienrbrt Awaiting requested review from julienrbrt julienrbrt is a code owner

@jeronimoalbi jeronimoalbi Awaiting requested review from jeronimoalbi jeronimoalbi is a code owner

@Ehsan-saradar Ehsan-saradar Awaiting requested review from Ehsan-saradar

@fadeev fadeev Awaiting requested review from fadeev

Assignees

@Ehsan-saradar Ehsan-saradar

Labels
component:ci CI/CD workflow and automated jobs. component:cmd component:configs component:docs Documentation additions or improvements.
Projects
Ignite CLI Masterboard
Status: Done
Milestone
v28
Development

Successfully merging this pull request may close these issues.

Improve scaffold query --help
6 participants
@AndrewDonelson @jeronimoalbi @Pantani @fadeev @Ehsan-saradar @julienrbrt