Skip to content

Update workflow.rst #16841

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

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

Update workflow.rst #16841

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions workflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -799,6 +799,10 @@ of domain logic in your templates:

``workflow_transitions()``
Copy link
Member

Choose a reason for hiding this comment

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

I would, for all functions in this list, inline the parameters in the function name:

Suggested change
``workflow_transitions()``
``workflow_transitions(object $subject, string $name = null)``

I think this is the most clear and concise way of documenting them.

Returns an array with all the transitions enabled for the given object.

- Parameters:
* object $subject,
* string $name = null : Workflow name ( first if null )

``workflow_transition()``
Returns a specific transition enabled for the given object and transition name.
Expand Down