zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Clarify axis info on media "focus" parameter (#953) 

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.
This commit is contained in:
mcclure 2022-07-16 08:02:20 -04:00 committed by GitHub
parent 47c8bdc4e9
commit 71e3ba0b1e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/en/methods/statuses/media.md
View File

@ -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 >}}