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

Issue #484: Added comment blocks to be more complete with arg specs et-al fo… #3113

Open
wants to merge 1 commit into
base: 1.x
Choose a base branch
from

Conversation

ps23Rick
Copy link
Contributor

@ps23Rick ps23Rick commented Apr 7, 2020

Fixes backdrop/backdrop-issues#484 (partial)
Initial rundown with alternate comment blocks. Seeking feedback on whether to continue or if further alterations are necessary/wanted.

@backdrop-ci
Copy link
Collaborator

Related to: backdrop/backdrop-issues#484

@backdrop-ci
Copy link
Collaborator

Website: http://3113.backdrop.backdrop.qa.backdropcms.org
Username: admin
Password: G53gNscF

@jenlampton
Copy link
Member

@ps23Rick these changes look great! I've added some comments about docs that need to be updated (I suspect they were incorrect before this PR) and provided some options for alternate wording in one case... What do you think of the options?

@ps23Rick
Copy link
Contributor Author

ps23Rick commented Apr 7, 2020

Hey @jenlampton.. I'm assuming you are referring to updates to the original issue#484.. It looks like the original post was updated since I looked at it yesterday/last night. It looks good.

If you'd like me to tackle more, I'm assuming you'll want something along the lines of a separate PR for maybe each directory or some other grouping that isn't obvious in my head at the moment. There are 181 instances of _preprocess_ in the entire tree -- I believe its very much a subset of that in which changes are needed. If you're OK with this thought, I'm thinking that I'll tackle a specific area of the tree, target 3-5 files (likely with each file having 3-5 changes in it) that need changes and create a new PR for that. Does that seem reasonable? Thx!

@jenlampton
Copy link
Member

I'm assuming you are referring to updates to the original issue#484

I left them as comments here, on the PR. See above? Hmm.. why do they say pending... I'll work on that...

I'm thinking that I'll tackle a specific area of the tree, target 3-5 files (likely with each file having 3-5 changes in it) that need changes and create a new PR for that. Does that seem reasonable? Thx!

Yep! The separate-PRs idea was primarily to keep you sane while working on them, so do whatever division feels reasonable to you :)

Copy link
Member

@jenlampton jenlampton left a comment

Choose a reason for hiding this comment

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

how do I submit this thing?

*
* @param $variables
* An array containing (but not limited to) the following:
* - css: The array of CSS files to be used for this page.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think there is a $css variable in Backdrop. We may need to fix the docs, these look like they are from Drupal 7... Can you check template_preprocess_page() in system.module?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok.. I'm not sure how to proceed on this.. I assumed the comments in page.tpl.php were accurate but as I well know in coding that is no guarantee. I found the offending template_preprocess_page() method located in ./core/includes/theme.inc. I didn't find any reference in system.module. Unfortunately without me having more knowledge of this body of code I'm not sure how to adjust this.

*
* @param $variables
* An array containing (but not limited to) the following:
* - css: The array of CSS files to be used for this page.
Copy link
Member

Choose a reason for hiding this comment

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

same here... Backdrop calls backdrop_get_css() in the template file. I don't think this variable exists before then since we have no process layer to alter it, so if used, this variable might print an incomplete set of CSS files.

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.

Update all preprocess docblocks
3 participants