search

backdrop-ops / docs.backdropcms.org

Website for displaying Backdrop CMS documentation and API source code.
https://docs.backdropcms.org/
6 stars 6 forks source link

Session documentation mentions $_SESSION superglobal but this is not documented in Globals #212

Closed yorkshire-pudding closed 1 year ago

yorkshire-pudding commented 1 year ago

This pages (and more) mention the $_SESSION superglobal but it doesn't appear to be documented anywhere what this is about.

https://docs.backdropcms.org/api/backdrop/core%21includes%21session.inc/1

The most obvious place would seem to be under Globals

bugfolder commented 1 year ago

$_SESSION is a PHP predefined variable:

https://www.php.net/manual/en/reserved.variables.session.php

Maybe just add a link to the online PHP manual?

yorkshire-pudding commented 1 year ago

Thanks @bugfolder - I hadn't realised that. Your suggestion makes sense.

bugfolder commented 1 year ago

Documentation for files and functions is contained in the code docblocks. So, for example, the documentation for file session.inc linked above is contained in the @file docblock at the top of the file (click "View Source" on that page to see it).

So, to make these changes (and related changes in the relevant functions), you should file a PR to core code with the documentation changes.

bugfolder commented 1 year ago

Issue and PR filed.

yorkshire-pudding commented 1 year ago

This has been merged.