The fact that focal point typically uses relative coordinates to represent itself and crop API uses absolute coordinates has led to a bit of confusion. Lets improve the documentation in FocalPointManagerInterface to make this less confusing for users

ORIGINAL SUMMARY (@dave reid)
I also found the docs for \Drupal\focal_point\FocalPointManagerInterface::saveCropEntity confusing because the X and Y coordinates are relative like a percentage, and not the actual X and Y coordinates.

CommentFileSizeAuthor
#3 x_and_y_arguments_in-2856994-3.patch3.61 KBbleen
#2 2856994-improve-x-y-coordinate-docs.patch836 bytesDave Reid
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Dave Reid created an issue. See original summary.

Dave Reid’s picture

Dave Reid
he/him
Primary language English
Location Nebraska USA
CreditAttribution: Dave Reid as a volunteer and at Lullabot commented
Status: Active » Needs review
FileSize
2856994-improve-x-y-coordinate-docs.patch836 bytes
bleen’s picture

bleen CreditAttribution: bleen at NBCUniversal commented
Title: X and Y arguments in FocalPointManagerInterface::saveCropEntity() are confusing. » X and Y arguments in FocalPointManagerInterface are confusing.
Issue summary: View changes
FileSize
x_and_y_arguments_in-2856994-3.patch3.61 KB

I slightly broadened the scope of this issue to include all the comments in FocalPointManagerInterface since a person who finds the saveCropEntity docs confusing is likely to find all the docs confusing for roughly the same reason.

bleen’s picture

bleen CreditAttribution: bleen at NBCUniversal commented
Status: Needs review » Fixed

I think this is objectively an improvement in the docs and there is no risk of anything breaking since there are no code changes .... committing

  • bleen committed 920b68e on 8.x-1.x 
    Issue #2856994 by Dave Reid, bleen: X and Y arguments in...

Status: Fixed » Closed (fixed)

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