Skip to content

Commit

Permalink
Clarify axis info on media "focus" parameter (#953)
Browse files Browse the repository at this point in the history
Today I read the media/ api endpoint document and was confused about the axis orientation (IE is y up or down). I initially implemented an endpoint call with the wrong Y orientation.

There is a helpful diagram but I did not see it because I foolishly scrolled down, saw the return codes section, assumed that was the end of the document, and didn't scroll further.

Edit adds a reference from the arguments section at the top to the detailed explanation of "focus" at the bottom of the page, so the next fool doesn't make the mistake I did.
  • Loading branch information
mcclure committed Jul 16, 2022
1 parent 47c8bdc commit 71e3ba0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion content/en/methods/statuses/media.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The custom thumbnail of the media to be attached, using multipart form data.
A plain-text description of the media, for accessibility purposes.
{{< endapi-method-parameter >}}
{{< api-method-parameter name="focus" type="string" required=false >}}
Two floating points \(x,y\), comma-delimited, ranging from -1.0 to 1.0
Two floating points \(x,y\), comma-delimited, ranging from -1.0 to 1.0 (see "Focal points" below)
{{< endapi-method-parameter >}}
{{< endapi-method-form-data-parameters >}}
{{< endapi-method-request >}}
Expand Down

0 comments on commit 71e3ba0

Please sign in to comment.