Skip to content

[Console] Documenting the helpers #1811

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.

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

Closed
stof opened this issue Oct 13, 2012 · 11 comments
Closed

[Console] Documenting the helpers #1811

stof opened this issue Oct 13, 2012 · 11 comments
Labels
good first issue Ideal for your first contribution! (some Symfony experience may be required)

Comments

@stof
Copy link
Member

stof commented Oct 13, 2012

The built-in console helpers should be documented

  • DialogHelper (providing interactions with the user)
  • FormatterHelper (formatting the output with colors, with a few more helper than doing the <info>foo</info> by hand)

the new 2.2 ProgressHelper is documented but it should probably be moved outside the introduction to the component to make it easier to find it.

@Sgoettschkes
Copy link
Contributor

I'll see what I can do

@wouterj
Copy link
Member

wouterj commented Nov 24, 2012

@Sgoettschkes I already started working on this, maybe you can finish it and improve my text (as my english isn't very well): WouterJ/symfony-docs@add_console_helpers

@Sgoettschkes
Copy link
Contributor

How would we collaborate on that? Do I fork your repository and then do a pull request on that one?

@wouterj
Copy link
Member

wouterj commented Nov 24, 2012

I don't think you need to fork it, you can just pull that branch inside your symfony/symfony-docs fork and create a PR if you are finished.

You can also start from stratch and use my branch as an 'example' or 'starting point' and do it your way.

@Sgoettschkes
Copy link
Contributor

Of course I can just use another remote. For some reason I didn't think about this one.

I'll have a look at it and improve where I see fit. I don't think there is a point in doing the work once more!

@Sgoettschkes
Copy link
Contributor

@wouterj I just read your docs and added a few things. I ended up changing only minor parts as it was very well written (as far as I can say) and added the missing parts on the formatter helper: sgoettschkes/symfony-docs@4de636102bc04c9259d3cd9438c3b132817381ca

@wouterj
Copy link
Member

wouterj commented Dec 4, 2012

@Sgoettschkes thank you, you did a great job too! Can you create a PR?

@weaverryan
Copy link
Member

Thanks to @Sgoettschkes, this is all documented now. But, I would like to move the ProgressHelper into the new format (individual document for each helper) that @Sgoettschkes created. Once we've done that, this can close.

Thanks!

@Sgoettschkes
Copy link
Contributor

I guess with the latest PR being closed this one can be closed too @weaverryan

@Sgoettschkes
Copy link
Contributor

ping @weaverryan

@wouterj
Copy link
Member

wouterj commented Mar 19, 2013

I'll close this, as all helpers are documented right now (you can find those in components/console/helpers).

@wouterj wouterj closed this as completed Mar 19, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Ideal for your first contribution! (some Symfony experience may be required)
Projects
None yet
Development

No branches or pull requests

4 participants