API page: http://api.drupal.org/api/drupal/sites--default--default.settings.php/7

Describe the problem you have found:
The list of where the settings.php file is searched for appears to have been malformed so it no longer displays correctly.

I know you folks are busy and a little burnt out so I have took the liberty of commenting a more readable list along with additional information that I feel is missing, such as information regarding the sites.php file.

I feel that it would be useful to look at the documentation for this page and update it to make the information more readable.

Before I go I would just like to say I've never came across documentation as extensive as the Drupal docs in my life, so I'm nit picking more than anything, but the main point is you have done a great job so well done.

Thanks,
Matt

Files: 
CommentFileSizeAuthor
#11 bullet_list-1262064-11.patch1 KBmichaellenahan
PASSED: [[SimpleTest]]: [MySQL] 32,941 pass(es).
[ View ]

Comments

Status:Active» Needs work

Do you have a patch or new file for review?

No because this is the documentation on the Drupal website, as previously linked to.

And that needs to be refactored as a patch.

Can you try that?

Version:7.x-dev» 8.x-dev

Hi Matthew,

The documentation you linked to is automatically generated from the Drupal source code. If you look at the source code for default.settings.php you will see the entire text of http://api.drupal.org/api/drupal/sites--default--default.settings.php/7 included in the documentation comments.

The way to get this fixed is to create a patch. See http://drupal.org/patch for more details. Basically, you modify your local copy of default.settings.php and change the text to be how you think it should be. Then create a patch, which shows the differences between your version and the version currently in Drupal core.

If you post the patch here, it can be reviewed for accuracy and wording, and after review it can be added to Drupal. Once that's done, it will show up in the website API documentation.

Additionally, core patches need to be committed to Drupal 8 first, then backported to Drupal 7. So I've moved this to the D8 issue queue.

Hi TR

Thanks for that, being new doesn't always help :)

I will do what you said and let you know how I get on.

Thanks,
Matt

@matt Sorry I wasn't more clear.

Status:Needs work» Active
Issue tags:+needs backport to D7

The problem is that the API module does not support numeric lists at all. So I am not sure how we would fix this so it would display properly on api.drupal.org.

Has this been created as another issue and shall I proceed with a patch or shall I wait until the API module has been updated?

I don't think it's an issue yet in the API module. I also don't think there is another file besides default.settings.php that needs numbered lists, so I don't think it's a very high priority. Maybe the default.settings.php file could be reformatted to use bullet lists (which are supported -- see http://drupal.org/node/1354 section on Lists)?

Title:Documentation problem with default.settings.phpdefault.settings.php has formatting issue with numbered list

Someone just filed this issue -- same problem as here with conf_path():
#1273032: conf_path() has formatting issue with numbered list

Status:Active» Needs review
StatusFileSize
new1 KB
PASSED: [[SimpleTest]]: [MySQL] 32,941 pass(es).
[ View ]

Here's the patch for the bullet list.

Status:Needs review» Reviewed & tested by the community

Looks good, thanks! Should apply to 7.x and 8.x.

Status:Reviewed & tested by the community» Fixed

Committed to 7.x and 8.x. Thanks.

Automatically closed -- issue fixed for 2 weeks with no activity.