Update index.md #3143

neeta-wagento · 2018-10-20T08:02:42Z

This PR is a:

Content update

Summary

Add example code to remove event as an event cannot be removed, add a comment near old one that it is deprecated and add one more event dispatching, with corrected name.

Additional information

List all affected URLs

https://devdocs.magento.com/guides/v2.1/contributor-guide/backward-compatible-development/

neeta-wagento · 2018-10-31T09:30:49Z

Hello @jeff-matthews !

Is there any update on this PR ?

Thank you!

jeff-matthews · 2018-10-31T12:14:58Z

Hi @neeta-wagento! Yes, we'll work on this today.

@dshevtsov, please work with @neeta-wagento to merge this PR so she can get credit for Squashtoberfest.

dshevtsov · 2018-10-31T16:17:38Z

It requires a tech review.
@buskamuza please review whether the contributed code example mets our current policy of backward compatibility.

dshevtsov · 2018-10-31T16:19:54Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

@@ -189,6 +189,21 @@ Do not remove or rename {% glossarytooltip c57aef7c-97b4-4b2b-a999-8001accef1fe
 Do not change argument types.
 Instead of changing argument name or type, introduce new event argument with new name or type and deprecate the old argument by adding `@deprecated` annotation before dispatching the event.

+
+{% collapsible Example Code %} {% highlight php startinline %} /**


Suggested change

{% collapsible Example Code %} {% highlight php startinline %} /**

Example:

```php?start_inline=1

/**

guides/v2.1/contributor-guide/backward-compatible-development/index.md

melnikovi · 2018-10-31T18:17:35Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+$transportObject = new DataObject($transport);
+
+    /**
+     * Event argument `transport` is @deprecated. Use `transportObject` instead.


Not sure it makes sense to use backticks in the comments, they have no meaning in PhpStorm.

The DevDocs team plans to implement a documentation generator for PHP API Reference that supports Markdown in the nearest future.

melnikovi · 2018-10-31T18:18:08Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+
+$transportObject = new DataObject($transport);
+
+    /**


Need to move this section to the left to align with the line above?

melnikovi · 2018-10-31T18:18:37Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+     */
+    $this->eventManager->dispatch(
+        'email_invoice_set_template_vars_before',
+        ['sender' => $this, 'transport' => $transportObject->getData(), 'transportObject' => $transportObject]


I suggest to use underscore for parameter names this is seem to be the convention used in most places.

@melnikovi please clarify what do you mean by term parameter. I didn't find this convention in our coding standards. Let me know if we should add one.

FYI Consider to use the Insert a suggestion feature on GitHub (<cmd-g>) to commit your suggested change.

Array indexes (transport, transportObject). We can add it as a suggestion

…index.md Co-Authored-By: neeta-wagento <neeta@wagento.com>

dshevtsov · 2018-11-01T18:46:18Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+
+$transportObject = new DataObject($transport);
+
+    /**


Suggested change

/**

/**

dshevtsov · 2018-11-01T18:47:02Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+$transportObject = new DataObject($transport);
+
+    /**
+     * Event argument `transport` is @deprecated. Use `transportObject` instead.


Suggested change

* Event argument `transport` is @deprecated. Use `transportObject` instead.

* Event argument `transport` is @deprecated. Use `transportObject` instead.

dshevtsov · 2018-11-01T18:47:41Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+
+    /**
+     * Event argument `transport` is @deprecated. Use `transportObject` instead.
+     */


Suggested change

*/

*/

dshevtsov · 2018-11-01T19:23:36Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+     */
+    $this->eventManager->dispatch(
+        'email_invoice_set_template_vars_before',
+        ['sender' => $this, 'transport' => $transportObject->getData(), 'transportObject' => $transportObject]


@melnikovi please clarify what do you mean by term parameter. I didn't find this convention in our coding standards. Let me know if we should add one.

FYI Consider to use the Insert a suggestion feature on GitHub (<cmd-g>) to commit your suggested change.

dshevtsov · 2018-11-06T17:17:45Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+    /**
+     * Event argument `transport` is @deprecated. Use `transportObject` instead.
+     */
+    $this->eventManager->dispatch(


Suggested change

$this->eventManager->dispatch(

$this->eventManager->dispatch(

dshevtsov · 2018-11-06T17:24:55Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+     * Event argument `transport` is @deprecated. Use `transportObject` instead.
+     */
+    $this->eventManager->dispatch(
+        'email_invoice_set_template_vars_before',


Suggested change

'email_invoice_set_template_vars_before',

'email_invoice_set_template_vars_before',

dshevtsov · 2018-11-06T17:25:25Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+     */
+    $this->eventManager->dispatch(
+        'email_invoice_set_template_vars_before',
+        ['sender' => $this, 'transport' => $transportObject->getData(), 'transportObject' => $transportObject]


Suggested change

['sender' => $this, 'transport' => $transportObject->getData(), 'transportObject' => $transportObject]

['sender' => $this, 'transport' => $transportObject->getData(), 'transport_object' => $transportObject]

dshevtsov · 2018-11-06T17:25:50Z

guides/v2.1/contributor-guide/backward-compatible-development/index.md

+    $this->eventManager->dispatch(
+        'email_invoice_set_template_vars_before',
+        ['sender' => $this, 'transport' => $transportObject->getData(), 'transportObject' => $transportObject]
+    );


Suggested change

);

);

dshevtsov · 2018-11-06T17:30:10Z

@neeta-wagento please review and apply the suggested changes

[DATA-4181] Added role to ProductViewPrice

Update index.md

ee8d3f0

jeff-matthews assigned dshevtsov Oct 22, 2018

jeff-matthews added the Technical Updates to the code or processes that alter the technical content of the doc label Oct 22, 2018

dshevtsov requested a review from buskamuza October 31, 2018 16:13

dshevtsov suggested changes Oct 31, 2018

View reviewed changes

dshevtsov added 2.1.x 2.2.x 2.3.x Magento 2.3 related changes labels Oct 31, 2018

melnikovi reviewed Oct 31, 2018

View reviewed changes

dshevtsov and others added 2 commits November 1, 2018 09:04

Update guides/v2.1/contributor-guide/backward-compatible-development/…

3558f72

…index.md Co-Authored-By: neeta-wagento <neeta@wagento.com>

Update guides/v2.1/contributor-guide/backward-compatible-development/…

2725918

…index.md Co-Authored-By: neeta-wagento <neeta@wagento.com>

dshevtsov added the Waiting for Response Waiting for response from internal/external parties label Nov 1, 2018

dshevtsov reviewed Nov 1, 2018

View reviewed changes

dshevtsov suggested changes Nov 6, 2018

View reviewed changes

Update the code example

41ae670

dshevtsov approved these changes Nov 6, 2018

View reviewed changes

dshevtsov merged commit fffce87 into magento:master Nov 6, 2018

dshevtsov removed the Waiting for Response Waiting for response from internal/external parties label Nov 6, 2018

magento-devops-reposync-svc pushed a commit that referenced this pull request Sep 15, 2022

Merge pull request #3143 from magento-commerce/db_productviewprice

4d2f774

[DATA-4181] Added role to ProductViewPrice

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update index.md #3143

Update index.md #3143

neeta-wagento commented Oct 20, 2018 •

edited by dshevtsov

Loading

neeta-wagento commented Oct 31, 2018 •

edited

Loading

jeff-matthews commented Oct 31, 2018

dshevtsov commented Oct 31, 2018 •

edited

Loading

dshevtsov Oct 31, 2018

melnikovi Oct 31, 2018

dshevtsov Oct 31, 2018 •

edited

Loading

melnikovi Oct 31, 2018

melnikovi Oct 31, 2018

dshevtsov Nov 1, 2018 •

edited

Loading

melnikovi Nov 6, 2018

dshevtsov Nov 1, 2018

dshevtsov Nov 1, 2018

dshevtsov Nov 1, 2018

dshevtsov Nov 1, 2018 •

edited

Loading

dshevtsov Nov 6, 2018

dshevtsov Nov 6, 2018

dshevtsov Nov 6, 2018

dshevtsov Nov 6, 2018

dshevtsov commented Nov 6, 2018

-{% collapsible Example Code %} {% highlight php startinline %} /**
+Example:
+```php?start_inline=1
+/**

	* Event argument `transport` is @deprecated. Use `transportObject` instead.
	* Event argument `transport` is @deprecated. Use `transportObject` instead.

	$this->eventManager->dispatch(
	$this->eventManager->dispatch(

	'email_invoice_set_template_vars_before',
	'email_invoice_set_template_vars_before',

	['sender' => $this, 'transport' => $transportObject->getData(), 'transportObject' => $transportObject]
	['sender' => $this, 'transport' => $transportObject->getData(), 'transport_object' => $transportObject]

Update index.md #3143

Update index.md #3143

Conversation

neeta-wagento commented Oct 20, 2018 • edited by dshevtsov Loading

This PR is a:

Summary

Additional information

neeta-wagento commented Oct 31, 2018 • edited Loading

jeff-matthews commented Oct 31, 2018

dshevtsov commented Oct 31, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dshevtsov Oct 31, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dshevtsov Nov 1, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dshevtsov Nov 1, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dshevtsov commented Nov 6, 2018

neeta-wagento commented Oct 20, 2018 •

edited by dshevtsov

Loading

neeta-wagento commented Oct 31, 2018 •

edited

Loading

dshevtsov commented Oct 31, 2018 •

edited

Loading

dshevtsov Oct 31, 2018 •

edited

Loading

dshevtsov Nov 1, 2018 •

edited

Loading

dshevtsov Nov 1, 2018 •

edited

Loading