Skip to content

Adds documentation for the new ISSN validator #2539

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

Merged
merged 1 commit into from
May 4, 2013

Conversation

ajgarlag
Copy link
Contributor

Q A
Doc fix? no
New docs? yes symfony/symfony#7756
Applies to 2.3+
Fixed tickets

Reference document for the new ISSN validator. Please, review it as my English is not very good.

Acme\JournalBundle\Entity\Journal:
properties:
issn:
- Issn:
Copy link
Member

Choose a reason for hiding this comment

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

- Issn: ~

@ajgarlag
Copy link
Contributor Author

@ricardclau I've added a link to the wikipedia article for ISSN and a versionadded statement.

Waiting for more feedback.

@ricardclau
Copy link
Contributor

You should surround the text you want to be the link with ` and use that text at the bottom of the rst document. Otherwise, as far as I know, the link will not work as expected.

As this is easier to see than to explain with words, please check https://raw.github.com/symfony/symfony-docs/master/reference/constraints/Luhn.rst

Notice that there is a link at the bottom but when the html is generated, link appears at the text written at line 7.

There should be something like this:

bla bla bla my text in the link_.

and at the end of the document

.. _my text in the link: http://en.wikipedia.org/wiki/whatever

@ajgarlag
Copy link
Contributor Author

Forgive me. I'm pretty new to the rst format.

The validator will allow non hyphenated ISSN values by default. When switching
this to ``true``, the validator requires an hyphenathed ISSN value.

.. _`ISSN`: http://en.wikipedia.org/wiki/Issn
Copy link
Member

Choose a reason for hiding this comment

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

please add a new line after the last line to avoid bad diffs if someone adds another link in this article

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

@ricardclau
Copy link
Contributor

No worries! I always have to double check on rst and even with it @wouterj corrects me most of the times ;)

Thanks for adding the link!

@ajgarlag
Copy link
Contributor Author

If you have no new comments, I will squash the commit. Any last minute comment?

@wouterj
Copy link
Member

wouterj commented Apr 23, 2013

No, I'm 👍 for this now.

@ajgarlag
Copy link
Contributor Author

Squashed! Thanks for your support with my first documentation contribution.

weaverryan added a commit that referenced this pull request May 4, 2013
Adds documentation for the new ISSN validator
@weaverryan weaverryan merged commit b6c36d2 into symfony:master May 4, 2013
weaverryan added a commit that referenced this pull request May 4, 2013
@weaverryan
Copy link
Member

Hi Antonio!

Very nice work and tweaks on this entry - it was basically perfect! I only had very minor tweaks at sha: 5821250

Thanks for your contribution!

@ajgarlag ajgarlag deleted the issn-validator branch November 4, 2014 08:07
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.

4 participants