API page: https://api.drupal.org/api/drupal/core%21includes%21entity.inc/function/...

> as of Drupal 8.0.x, will be removed before Drupal 9.0.0. If the entity form display is available in configuration use:

This doesn't say what to use!

CommentFileSizeAuthor
#2 2892469-2.patch1.51 KBshashikant_chauhan

Comments

joachim created an issue. See original summary.

shashikant_chauhan’s picture

shashikant_chauhan commented
Status: Active » Needs review
StatusFileSize
new 2892469-2.patch1.51 KB

Adding patch.

lomasr’s picture

lomasr commented

Patch worked fine for me. Thanks

aburrows’s picture

aburrows commented
Status: Needs review » Needs work

All the changes do are indent the comments..

joachim’s picture

joachim commented
Status: Needs work » Needs review

That might be all that is needed though?

The problem is not that anything is missing from the documentation, but that what is in the documentation isn't getting output on the API site. So it is a formatting problem, as API module is not picking up on the whole of the deprecation notice. Aligning it with the start of the notice looks like it could be the right fix.

shashikant_chauhan’s picture

shashikant_chauhan commented

Here is the example which shows the correct display when it's formatted/indented.

https://api.drupal.org/api/drupal/core%21includes%21entity.inc/function/...

joachim’s picture

joachim commented
Status: Needs review » Reviewed & tested by the community

Thanks for the link!

Looking at the source of that function's docs to see how it's formatted (https://api.drupal.org/api/drupal/core%21includes%21entity.inc/8.2.x), I think the patch here fixes the problem.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Status: Reviewed & tested by the community » Postponed (maintainer needs more info)

So what is the issue on https://api.drupal.org/api/drupal/core%21includes%21entity.inc/function/... ? I see it displays the code example already as it should. What are we fixing here?

joachim’s picture

joachim commented
Status: Postponed (maintainer needs more info) » Reviewed & tested by the community

It displays the code example in the main part of the docs, but not the code example in the deprecation notice. That just says:

as of Drupal 8.0.x, will be removed before Drupal 9.0.0. If the entity form display is available in configuration use:

and stops at 'use:'.

  • Gábor Hojtsy committed e75fef0 on 8.4.x 
    Issue #2892469 by shashikant_chauhan: deprecation notice for...
gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Status: Reviewed & tested by the community » Fixed

You are right, I was looking at the wrong thing. Thanks for pushing this back.

  • Gábor Hojtsy committed 5c0c873 on 8.3.x 
    Issue #2892469 by shashikant_chauhan: deprecation notice for...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.