[Console] Document console cursor #15270
Conversation
|
(The “code block” ci job does not support adding new files. I’ll fix that in a separate pr) |
|
The CI job is updated. Regarding your PR: Do we need to create a new page or is there an existing page we can add this content to? |
|
@Nyholm Thank you for the CI If you or other found a better place,, I will be pleased to swap the code of course :) |
|
Oh. Hmm.. I see. There is a greater plan to make everything under one document. I'll wait for input from the docs team. Btw, test retrigger the CI with: |
noniagriconomie
changed the title
|
Cool. Another CI error. We dont support non-rst files =) I should filter out these too. |
|
May I bother you to trigger the CI again? |
|
@Nyholm here you are :) |
|
Wohoo. The CI is green. Thank you for helping me. I am also happy with the content of this PR. |
There was a problem hiding this comment.
Thanks a lot for starting this @noniagriconomie!
I think we should document all available methods. I've made some suggestions on how to do this somewhat briefly below (to avoid long boring listings).
I'm fine with keeping it in a separate document. It seems the most logical from the current Console documentation structure. We can always revisit this when we start working on the Console docs
|
@wouterj many thanks for the reviews, I've tried to address them all edit: I do not understand the CI sphinx error |
| // move the cursor to a specific position from its current position | ||
| $cursor->moveToPosition(7, 11); |
There was a problem hiding this comment.
I haven't used this feature, but I think we have to clearify this a bit. This means 7 lines down, and 11 columns to the right? And I can use negative numbers to achieve the opposite?
Or does this expect a coordinate?
There was a problem hiding this comment.
@wouterj it means 7 cols right, 11 rows down from console init cursor
the cursor always moves position from this 0:0 position, thus need an x:y (here positive values) from the init yes
noniagriconomie
force-pushed
the
console-cursor
branch
from
773a151
to
ee2a5a5
Compare
|
friendly ping @OskarStark I may hope you are the best to ping here related to the error I have: I've check other code bloc and for me it is "correct" here, or what am I doing wrong? many thanks :) |
|
Thank you @noniagriconomie ! I'm sorry this took a while... The build error appears to be a bug in DOCtor (@OskarStark), I've silenced the rule for now (along with some minor changes) in 7565926 |
* upstream/5.2: [symfony#15270] Minor fixes [Console] Document console cursor
* 5.2: Minor tweaks Adds a heading for stampede prevention so I'm able to reference this section easily [symfony#15270] Minor fixes [Console] Document console cursor Update routing.rst
* 5.3: Minor tweaks Adds a heading for stampede prevention so I'm able to reference this section easily [symfony#15270] Minor fixes [Console] Document console cursor [Security] changed interface name to the correct one [Form] Fixed a code example related to CSRF Update routing.rst Typo
* 5.4: Minor tweaks Adds a heading for stampede prevention so I'm able to reference this section easily [symfony#15270] Minor fixes [Console] Document console cursor [Security] changed interface name to the correct one [Form] Fixed a code example related to CSRF Update routing.rst Typo
fixes #13529
feature symfony/symfony#27444
ping @wouterj I've seen your slack recently and wanted to give it a try as I will use the feature very soon :)
feel free to comment, specialy if I need to document all the cursor features or not
text and image taken from the feature PR description
inspired by https://symfony.com/doc/current/components/console/helpers/progressbar.html