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

Rewrite doc using RestructuredText #213

Merged
merged 1 commit into from
Feb 24, 2016
Merged

Rewrite doc using RestructuredText #213

merged 1 commit into from
Feb 24, 2016

Conversation

egeloen
Copy link
Owner

@egeloen egeloen commented Feb 21, 2016

This PR fixes #210 and is related to symfony/symfony-docs#6248

@egeloen
Copy link
Owner Author

egeloen commented Feb 21, 2016

@javiereguiluz let me know what do you think. I have build it with sphinx and all is well.

@javiereguiluz
Copy link
Contributor

@egeloen thanks for updating the format of your documentation. 95% of your doc is right, but there were some syntax issues. These were mostly related to long lines, so instead of adding comments to this pull request, I've created a new one in #214.

The new pull request has been created against the doc branch, so if everything goes right, you could merge my pull request on top of yours and keep working on your pull request until you merge it in the bundle.

Thanks again for transforming all the documentation!

@egeloen
Copy link
Owner Author

egeloen commented Feb 22, 2016

Thanks as well for your PR! Can you ealoborate about the line length? I have not seen somethink like that in the "Symfony doc" documentation. Is it somethink related to Sphinx or it is only for consistency?

@javiereguiluz
Copy link
Contributor

The line length limit and other specific format rules are defined in this doc: http://symfony.com/doc/current/contributing/documentation/standards.html This limit is not because of Sphinx but because we think this makes the doc more readable in any format and situation (if you read the raw documentation, short lines make it look well).

@egeloen
Copy link
Owner Author

egeloen commented Feb 22, 2016

Sorry, I was searching the length keyword in the page and not char one... (too lazy to read everything this morning...)

Anyway, thanks for the explanation, let's follow this rule :)

@egeloen egeloen mentioned this pull request Feb 22, 2016

.. code-block:: php

$builder->add('field', 'ckeditor', array('auto_inline' => false));
Copy link

Choose a reason for hiding this comment

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

as these 2 examples are showing different things (config vs widget), I recommend to use 2 seperate code blocks/examples. the tabbed code blocks (configuration block) is often used to show the same feature in different formats.

Copy link
Owner Author

Choose a reason for hiding this comment

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

Done

@egeloen
Copy link
Owner Author

egeloen commented Feb 24, 2016

@javiereguiluz I see you remove some code-block tags (for example here). Is it intended for?

@javiereguiluz
Copy link
Contributor

@egeloen yes. This is because Symfony uses a trick to highlight PHP code without creating a very verbose documentation. I don't agree with this trick (I think it's an ugly and dangerous hack) but it's used everywhere in the Symfony docs, so it's "the official way of doing things".

The trick is to remove .. code-block:: php and add two colons :: in the paragraph previous to the code:

BEFORE
If you want to override some parts of the defined config, you can still use the
``config`` option:

.. code-block:: php

    $builder->add('field', 'ckeditor', array(
        'config_name' => 'my_config',


AFTER
If you want to override some parts of the defined config, you can still use the
``config`` option::

    $builder->add('field', 'ckeditor', array(
        'config_name' => 'my_config',

egeloen pushed a commit that referenced this pull request Feb 24, 2016
Rewrite doc using RestructuredText
@egeloen egeloen merged commit 6b45d41 into master Feb 24, 2016
@egeloen egeloen deleted the doc branch February 24, 2016 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Making IvoryCKEditorBundle an "official" Symfony bundle
4 participants