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.

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

Misc. improvements in the Console component introduction #5545

Closed
wants to merge 3 commits into from

Conversation

javiereguiluz
Copy link
Member

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets -

@@ -140,6 +140,9 @@ output. For example::
// white text on a red background
$output->writeln('<error>foo</error>');

The closing tag can be replaced by just ``</>``. This makes the component to
stop applying any style defined by the immediately previous open tag.
Copy link
Member

Choose a reason for hiding this comment

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

I would reword this a bit:

The closing tag can be replaced by </> which simply closes the last opened tag.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't like my original text ... but I don't like either the new proposal. My fear is that reader would say: obviously the close tag closes the opened tag!!! In this case, the close tag is not about closing tags but about "neutralizing" the effects applied in the previously opened tag. I don't know if I explained myself because it's not easy to explain what I want to say :(

Copy link
Member

Choose a reason for hiding this comment

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

Maybe then something like

The closing tag can be replaced by </> which revokes all formatting options established by the last opened tag.

Copy link
Member Author

Choose a reason for hiding this comment

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

I like it. I've just updated it. Thanks!

@xabbuh
Copy link
Member

xabbuh commented Jul 21, 2015

👍

And available options are: ``bold``, ``underscore``, ``blink``, ``reverse``
(enables the "reverse video" mode where the background and foreground colors
are swapped) and ``conceal`` (the text will be hidden; commonly used to ask
the user to type sensitive information).
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is a very good explanation of conceal. It just makes the foreground color transparent. The text is still there (and visible when copy/pasting the terminal text). Besides that, the "input box" of questions can't be styled.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've reworded the explanation. Thanks.

@wouterj
Copy link
Member

wouterj commented Jul 23, 2015

👍

@xabbuh
Copy link
Member

xabbuh commented Jul 23, 2015

Thanks Javier.

xabbuh added a commit that referenced this pull request Jul 23, 2015
…(javiereguiluz)

This PR was squashed before being merged into the 2.3 branch (closes #5545).

Discussion
----------

Misc. improvements in the Console component introduction

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets | -

Commits
-------

40eb0bd Misc. improvements in the Console component introduction
@xabbuh xabbuh closed this Jul 23, 2015
@javiereguiluz javiereguiluz deleted the tweak_console_docs branch May 24, 2018 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants