Document Company soft delete event#506
Conversation
| @@ -0,0 +1,74 @@ | |||
| Company soft deleted event | |||
There was a problem hiding this comment.
Added documentation for the COMPANY_SOFT_DELETE event from LeadEvents.php:714-716 which dispatches mautic.company_soft_delete with a CompanyEvent instance when companies are marked as deleted via CompanyModel::deleteEntity().
Source: mautic/mautic#16176
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions
|
Thanks for the feedback, @adiati98! I've addressed all your suggestions:
Ready for another review! |
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions
|
Thanks for the feedback, @adiati98! I've addressed both suggestions:
|
|
Thanks for the feedback! I've added the "See" prefix to the Company properties reference as suggested. |
|
Thanks for the feedback, @fedys! I've added the "Event instance" section with the |
|
Removed the "Event properties" section as requested. The documentation now includes the event type, event instance class, code example, and related links without the incorrect properties table. |
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions.
|
Thanks for catching these! I've removed both unused anchor labels:
Verified neither was referenced anywhere in the docs before removing. |
|
@promptless-for-oss please rebase to 7.2 branch. |
Document the new COMPANY_SOFT_DELETE event (mautic.company_soft_delete) introduced in PR #16176 for improved company-contact relationship handling. This event is dispatched when a Company is marked as soft deleted, before permanent deletion occurs.
- Add custom reference target for Company properties cross-reference - Update link to use :ref: with custom target - Remove trailing period from timestamp description - Add vale off/on tags around description paragraph - Expand CRM abbreviation to Customer Relationship Management (CRM) - Add CRM to Vale accept.txt vocabulary
- Change passive "are marked" to active "Mautic marks" - Update CRM abbreviation format to use dashes per style guide
Address reviewer feedback to add "See" before the cross-reference to Company properties section.
The Event properties table contained incorrect information, as noted by reviewer @fedys.
Remove two anchor labels that are not referenced anywhere: - _company_soft_deleted_event_type in company_soft_delete.rst - _Company properties at Company created updated event in company_post_save.rst
promptless-for-oss
force-pushed
the
promptless/pr-16176-company-soft-delete
branch
from
939347a to
a409684
Compare
|
Done! I've rebased this branch onto the Note: The PR's base branch will also need to be updated to |
|
@promptless-for-oss please close and reopen this PR to trigger the GitHub actions that are stuck. |
|
Done! I've closed and reopened the PR to re-trigger the GitHub Actions. |
3 participants
Open this suggestion in Promptless to view citations and reasoning process
Add documentation for the new COMPANY_SOFT_DELETE event (mautic.company_soft_delete) that is dispatched when a Company is marked as soft deleted. Includes event type, properties, and a code example for subscribing to the event.
Trigger Events
Tip: Whenever you leave a comment tagged
@Promptlesson a Promptless PR, Promptless will remember it for future suggestions 🧠