Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.It would seem that it's possible to set 'optional' => TRUE on a variable in hook_rules_event_info().
However, this isn't documented in the hook.
Also, what are the consequences of doing this, if anything in a rule relies on this variable?
Comments
Comment #1
TR CreditAttribution: TR commentedComment #2
joachim CreditAttribution: joachim as a volunteer commentedThis is a bug report because it's incomplete documentation.
Comment #3
TR CreditAttribution: TR commentedIf you would like to contribute to Rules, there are hundreds of things you could be doing to help. Nitpicking my choice of issue category on a 6 year old issue is not one of those things.
All the Rules documentation is editable by the general community - you don't need anyone's approval to add missing information or correct wrong information. You could have done that any time in the past 6 years.
It is not common practice in Drupal to classify missing or incomplete documentation as a bug. In the Rules queue, we have been treating reports of missing/incomplete documentation as support requests or tasks. I changed the status as part of my issue queue triage, to be consistent with how all the other posts are categorized and to help me manage the queue and maintain this project. I'd appreciate it if you would leave the category alone, or better yet help out by using some of your expertise to answer the open support questions, review the open patches, and/or improve the existing documentation.
Comment #4
joachim CreditAttribution: joachim as a volunteer commented> All the Rules documentation is editable by the general community - you don't need anyone's approval to add missing information or correct wrong information. You could have done that any time in the past 6 years.
This is about the API documentation in the api.php file, not in the community docs.
> It is not common practice in Drupal to classify missing or incomplete documentation as a bug.
Actually, it is. And not doing so falsely diminishes the importance of documentation.
Comment #5
TR CreditAttribution: TR commentedI don't have time for this BS (bikeshedding). My long-term contributions to and support for documentation in Drupal and contrib are well established and easily confirmed. If you want to submit a patch to rules.api.php, then please do so in another issue. If you're not willing to help, then at least please stop making it more difficult for those of us who are trying to do the work.
Comment #6
joachim CreditAttribution: joachim as a volunteer commentedClosing this is just being childish.
I opened this issue to alert the maintainers and contributors to a documentation bug. I wasn't expecting anything from it, but the least you can do is leave it open as a bug. It's not costing you any time or effort to just leave it alone.
> It is not common practice in Drupal to classify missing or incomplete documentation as a bug.
It absolutely is practice in Drupal to treat missing documentation as a bug. Please check Drupal core issues, as you seem to not believe me.
Comment #7
TR CreditAttribution: TR commentedAs I said,
I have asked to you respect my choice to deal with this in the same manner as similar issues in this queue. You apparently are not willing to do so.
I did leave it open, but you refused to accept my categorization. Again, if you want to contribute, submit a patch.
The issue is you not respecting the maintainer's decision. You are not contributing to the community here, you're just hindering.
Comment #8
joachim CreditAttribution: joachim as a volunteer commentedYou know what, I contributed. I spotted an omission in the docs while I was working on something else, and I took the time to report it.
You came along and devalued my contribution.
I'm not going to contribute any further to a project that doesn't value documentation. I won't bother posting anything in the Rules issue queue again.