Skip to content

Commit 7ba49bf

Browse files
committed
'Note:' is almost always redundant
1 parent a98427c commit 7ba49bf

File tree

16 files changed

+19
-19
lines changed

16 files changed

+19
-19
lines changed

content/reference/authentication/flows/app-access-token.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ with URL-encoded POST body:
1919
&client_secret=[your client secret]
2020
&grant_type=client_credentials
2121

22-
> Note: we also accept the `client_id` and `client_secret` parameters via the Authorization header, as described in [section 2.3.1 of the spec](http://tools.ietf.org/html/rfc6749#section-2.3.1).
22+
> We also accept the `client_id` and `client_secret` parameters via the Authorization header, as described in [section 2.3.1 of the OAuth 2 spec](http://tools.ietf.org/html/rfc6749#section-2.3.1).
2323
2424
App.net will respond with a JSON-encoded token:
2525

content/reference/authentication/flows/web.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Your `redirect_uri` must be registered with App.net before you can use it.
4545
&redirect_uri=[your registered redirect URI]
4646
&code=[code received from redirect URI]
4747

48-
> Note: we also accept the `client_id` and `client_secret` parameters via the Authorization header, as described in [section 2.3.1 of the spec](http://tools.ietf.org/html/rfc6749#section-2.3.1).
48+
> We also accept the `client_id` and `client_secret` parameters via the Authorization header, as described in [section 2.3.1 of the OAuth 2 spec](http://tools.ietf.org/html/rfc6749#section-2.3.1).
4949
5050
1. App.net will respond with a JSON-encoded token: `{"access_token": "[user access token]", "token": {...Token object...}}`
5151

content/reference/authentication/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ When making a call to one of our API resources, there are three ways to include
137137

138138
* Add `access_token` to HTTP body.
139139

140-
> Note: this method will only work with the `PUT`, `POST`, and `PATCH` methods. `GET` and `DELETE` do not accept an HTTP body.
140+
> This method will only work with the `PUT`, `POST`, and `PATCH` methods. `GET` and `DELETE` do not accept an HTTP body.
141141
142142
<%= curl_example(:post, "posts", :none, {
143143
:data => {"text" => "Test post", "access_token" => "<YOUR ACCESS TOKEN>"},

content/reference/make-request/responses.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: "Responses"
99

1010
All responses to requests to the App.net API endpoints listed under [Resources](/reference/resources/), whether successful or not, will be returned in the same type of envelope structure. This document describes how that envelope works and what it may contain.
1111

12-
*Please note: the [authentication endpoints](/reference/authentication) return a slightly different format that follows the OAuth2 specification.*
12+
*The [authentication endpoints](/reference/authentication) return a slightly different format that follows the OAuth2 specification.*
1313

1414
## Response Envelope
1515

@@ -63,7 +63,7 @@ To request pretty-printing, send the following HTTP header with your request:
6363

6464
X-ADN-Pretty-JSON: 1
6565

66-
*Note: Sending any value is sufficient. Omit the header entirely if you wish to receive minified JSON.*
66+
Sending any value is sufficient. Omit the header entirely if you wish to receive minified JSON.
6767

6868
## Error Conditions
6969

content/reference/meta/entities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Usually entities are extracted from the Post text by App.net's servers. We allow
1313

1414
Ranges specified by entities may be adjacent, but may not overlap.
1515

16-
<div class="alert alert-info"><b>Note:</b> <code>pos</code> and <code>len</code> fields are given as UTF-32 code points. Many string implementations (in particular, Cocoa's NSString class and Javascript's strings) use UTF-16 or UCS-2 encoding internally, and thus the indices given will not map directly to UTF-16 code points if encoded with surrogate pairs, e.g., emoji characters.</div>
16+
<div class="alert alert-info"><code>pos</code> and <code>len</code> fields are given as UTF-32 code points. Many string implementations (in particular, Cocoa's NSString class and Javascript's strings) use UTF-16 or UCS-2 encoding internally, and thus the indices given will not map directly to UTF-16 code points if encoded with surrogate pairs, e.g., emoji characters.</div>
1717

1818
All of the following examples are about the following text:
1919

content/reference/other/feeds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ There are 2 different kinds of feeds, but they all follow the same pattern:
1818

1919
We intend to support more feed formats and richer support for filters in the near future.
2020

21-
*Note:* While the URLs are similar to other API URLs feeds, they are under a different root.
21+
While the URLs are similar to other API URLs feeds, they are under a different root.
2222

2323
## Filters
2424

content/reference/other/web-intents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Web intents are an easy way to integrate with App.net; you don't even need to us
1111

1212

1313
<div class="alert alert-info alert-block">
14-
<p><strong>Note:</strong> If you just want a simple follow or share button you can use <a href='http://app.net/about/buttons/'>button builder</a> instead. We've also open sourced the buttons so that you could host them your self. Checkout the <a href="https://github.com/appdotnet/piha">github repo</a> for more information on how to do that.</p>
14+
<p>If you just want a simple follow or share button you can use <a href='http://app.net/about/buttons/'>button builder</a> instead. We've also open sourced the buttons so that you could host them your self. Checkout the <a href="https://github.com/appdotnet/piha">github repo</a> for more information on how to do that.</p>
1515
</div>
1616

1717
## The Post Intent

content/reference/resources/file/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Derived files will include the keys shown in the example below. Please see [the
200200

201201
### Auto-generated derived files
202202

203-
For some files, App.net will auto generate derived files. *Note: any new auto-generated derived file keys will be prefixed with `core_`.*
203+
For some files, App.net will auto generate derived files. *Any new auto-generated derived file keys will be prefixed with `core_`.*
204204

205205
* `image_thumb_200s`: When the root file is an image, App.net will generate a 200x200 square thumbnail of the image that shrinks and crops the center square of the image.
206206
* `image_thumb_960r`: When the root file is an image, App.net will scale down the entire image so it fits within a 640x960 pixel bounding box. This thumbnail will not be cropped.

content/reference/resources/interaction/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: "Interactions"
99

1010
Interactions are objects that represent users taking certain actions on App.net. Interactions are structured to form a sentence like: User X took action Y on object Z. If multiple users take the same action (e.g. multiple users reply to one post) within a set time window those events will be combined into a single Interaction.
1111

12-
> Note: the `objects` list of an Interaction will vary based on the `action`
12+
> The `objects` list of an Interaction will vary based on the `action`
1313
1414
(Example) @dalton and @berg reposted post 1:
1515

@@ -59,10 +59,10 @@ List all the [Interactions](/reference/resources/interaction/) other users have
5959

6060
<%= pagination_note %>
6161

62-
> Note: you can only request this list for the current user.
62+
> You can only request this list for the current user.
6363
6464
<!-- blockquote break -->
65-
> Note: although this endpoint supports paging, a user's Interactions stream is continuously rebuilt as new actions in the system occur, so developers should generally plan to refetch the stream whenever switching to display it as Interactions may have shifted their position, with users being added or removed. If you need to keep track of activity in a more precise manner, you should using the [Streaming API](/reference/resources/app-stream/) to monitor the global feed for relevant activity.
65+
> Although this endpoint supports paging, a user's Interactions stream is continuously rebuilt as new actions in the system occur, so developers should generally plan to refetch the stream whenever switching to display it as Interactions may have shifted their position, with users being added or removed. If you need to keep track of activity in a more precise manner, you should using the [Streaming API](/reference/resources/app-stream/) to monitor the global feed for relevant activity.
6666
6767
This endpoint accepts the `interaction_actions` as a query string parameter whose value is a comma separated list of actions you're interested in. For instance, if you're only interested in repost and follow interactions you could request `stream/0/users/me/interactions?interaction_actions=repost,follow`.
6868

content/reference/resources/message/lifecycle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ end %>
5252

5353
Delete a message. The current user must be the same user who created the Message. It returns the deleted Message on success.
5454

55-
*Note: you can always delete a message you created even if you are no longer able to view the rest of the Channel anymore.*
55+
*You can always delete a message you created even if you are no longer able to view the rest of the Channel anymore.*
5656

5757
*Remember, access tokens can not be passed in a HTTP body for `DELETE` requests. Please refer to the [authentication documentation](/reference/authentication/#making-authenticated-api-requests).*
5858

0 commit comments

Comments
 (0)