Skip to content

Normalize the method listings #3903

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.

Sign up for GitHub

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

Jump to bottom
Closed
javiereguiluz opened this issue Jun 3, 2014 · 4 comments
Closed

Normalize the method listings #3903

javiereguiluz opened this issue Jun 3, 2014 · 4 comments
Labels
actionable Clear and specific issues ready for anyone to take them. good first issue Ideal for your first contribution! (some Symfony experience may be required)

Comments

@javiereguiluz
Copy link
Member

When listing a lot of related methods, documentation pages use different strategies:

1) Regular <ul> lists (see http://symfony.com/doc/current/components/http_foundation/sessions.html#session-api)

regular_ul_list

2) Regular <dl> lists (see http://symfony.com/doc/current/components/config/definition.html#default-and-required-values)

regular_dl_list

3) Weird mix of <ul> and <dl> lists

weird_mix_of_ul_and_dl

Is it worth it to normalize these method listings?
@wouterj
Copy link
Member

wouterj commented Jun 3, 2014

Yes, it is worth normalizing. Consistency is an important part of good docs imo.

I'm +1 for the definition list variant, I didn't knew it existed before this issue :)

@weaverryan
Copy link
Member

Yep, I like the dl one too. I like consistency, but I like even more using what looks best in the most places.

@xabbuh
Copy link
Member

xabbuh commented Oct 11, 2014

I agree with you that the definition lists look the best.

@xabbuh xabbuh added actionable Clear and specific issues ready for anyone to take them. good first issue Ideal for your first contribution! (some Symfony experience may be required) labels Oct 11, 2014
@pedronofuentes pedronofuentes mentioned this issue Nov 29, 2014
Merged
ternel added a commit to ternel/symfony-docs that referenced this issue Nov 29, 2014
@ternel
Ref symfony#3903 - Normalize methods listings
308e0f0
@ternel ternel mentioned this issue Nov 29, 2014
Closed
@pedronofuentes pedronofuentes mentioned this issue Nov 29, 2014
Closed
wouterj added a commit that referenced this issue Dec 17, 2014
@wouterj
minor #4551 Normalize the method listings on version 2.5 (pedronofuen…
815e0bf 
…tes)

This PR was squashed before being merged into the 2.5 branch (closes #4551).

Discussion
----------

Normalize the method listings on version 2.5

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | no
| Applies to    | 2.5
| Fixed tickets | #3903

This pull request is related with #4539. Normalizes listings from 2.5

Commits
-------

2665407 Normalize the method listings on version 2.5
weaverryan added a commit that referenced this issue Dec 20, 2014
@weaverryan
minor #4539 Normalization of method listings (pedronofuentes)
96455e6 
This PR was merged into the 2.3 branch.

Discussion
----------

Normalization of method listings

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | no
| Applies to    | all
| Fixed tickets | fixes #3903

Commits
-------

3fd3963 Changed to definition lists from Book section
dda1905 Changed to definition lists
3649bdb Fixed heading capitalization to follow the standards
6b68e48 Changed paragraph to heading
1d571ca Changed unordered list to definition list
@xabbuh
Copy link
Member

xabbuh commented Dec 21, 2014

We should also merge #4550.

@xabbuh xabbuh reopened this Dec 21, 2014
ternel added a commit to ternel/symfony-docs that referenced this issue Dec 21, 2014
@ternel
Ref symfony#3903 - Normalize methods listings
7054cf4
ternel added a commit to ternel/symfony-docs that referenced this issue Dec 21, 2014
@ternel
Ref symfony#3903 - Forms: normalize methods list for form_start / for…
f88d8af 
…m_error / form_end
ternel added a commit to ternel/symfony-docs that referenced this issue Dec 21, 2014
@ternel
Ref symfony#3903 - new list normalized
9ee8a1f
ternel added a commit to ternel/symfony-docs that referenced this issue Dec 21, 2014
@ternel
Ref symfony#3903 - new list normalized
0912b19
wouterj pushed a commit that referenced this issue Dec 22, 2014
@ternel @wouterj
Ref #3903 - Normalize methods listings
9039e5b
wouterj added a commit that referenced this issue Dec 22, 2014
@wouterj
minor #4550 Ref #3903 - Normalize methods listings (ternel)
459875b 
This PR was squashed before being merged into the 2.3 branch (closes #4550).

Discussion
----------

Ref #3903 - Normalize methods listings

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3+
| Fixed tickets | #3903

I only did this on methods listings which have some informations about the methods. (ie. I didn't change anything on this page: http://symfony.com/doc/current/contributing/code/conventions.html#method-names)

Commits
-------

9039e5b Ref #3903 - Normalize methods listings
@xabbuh xabbuh closed this as completed Dec 22, 2014
weaverryan added a commit that referenced this issue Dec 23, 2014
@weaverryan
Merge branch '2.3' into 2.5
ce74c31 
* 2.3:
  Fix for symfony code standards
  Ref #3903 - Normalize methods listings
  drop varnish 2 example from varnish cookbook article
  Rewrite the varnish cookbook article
  Fixes and tweaks
  Change PHPUnit link to avoid redirect to homepage
  Harmonize PHPUnit version to 4.2 or above
  Remove redundant "default" connection.
  More tweaks and grammar fixes
  Rewordings and transformed a list into a definition list
  More grammar fixes
  Minor grammar fix
  Fixed some errors in the explanation
  Documented the console environment variables
  update ordered list syntax
  Add  missing autoload include in basic application example
weaverryan added a commit that referenced this issue Dec 23, 2014
@weaverryan
Merge branch '2.5' into 2.6
b45313a 
* 2.5:
  Fix for symfony code standards
  Ref #3903 - Normalize methods listings
  drop varnish 2 example from varnish cookbook article
  Rewrite the varnish cookbook article
  Fixes and tweaks
  Change PHPUnit link to avoid redirect to homepage
  Harmonize PHPUnit version to 4.2 or above
  Remove redundant "default" connection.
  More tweaks and grammar fixes
  Rewordings and transformed a list into a definition list
  More grammar fixes
  Minor grammar fix
  Fixed some errors in the explanation
  Documented the console environment variables
  update ordered list syntax
  Add  missing autoload include in basic application example
  Added cache_busting to default asset config
weaverryan added a commit that referenced this issue Dec 23, 2014
@weaverryan
Merge branch '2.7'
4056218 
* 2.7:
  Fix for symfony code standards
  Ref #3903 - Normalize methods listings
  drop varnish 2 example from varnish cookbook article
  Rewrite the varnish cookbook article
  Fixes and tweaks
  Change PHPUnit link to avoid redirect to homepage
  Harmonize PHPUnit version to 4.2 or above
  Remove redundant "default" connection.
  More tweaks and grammar fixes
  Rewordings and transformed a list into a definition list
  More grammar fixes
  Minor grammar fix
  Fixed some errors in the explanation
  Documented the console environment variables
  Changed the "new in Symfony 2.6" message for consistency
  Documented getProgress/setProgress methods
  update ordered list syntax
  Add  missing autoload include in basic application example
  Added cache_busting to default asset config
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
actionable Clear and specific issues ready for anyone to take them. good first issue Ideal for your first contribution! (some Symfony experience may be required)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@javiereguiluz @weaverryan @wouterj @xabbuh