Skip to content

Commit

Permalink
fix long lines
Browse files Browse the repository at this point in the history
  • Loading branch information
MariusStorhaug committed Oct 29, 2023
1 parent a6bcd01 commit 49475db
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 11 deletions.
6 changes: 4 additions & 2 deletions src/GitHub/public/Meta/Get-GitHubMeta.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@
Get GitHub meta information.
.DESCRIPTION
Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."
Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see
"[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."
The API's response also includes a list of GitHub's domain names.
The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
**Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
**Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific
documentation for each feature to determine if IPv6 is supported.
.EXAMPLE
Get-GitHubMeta
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
List app installations for an organization
.DESCRIPTION
Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.
Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization.
You must be an organization owner with `admin:read` scope to use this endpoint.
.EXAMPLE
Get-GitHubOrganizationAppInstallation -OrganizationName 'github'
Expand Down
13 changes: 9 additions & 4 deletions src/GitHub/public/Status/Get-GitHubStatus.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@
Gets the status of GitHub services
.DESCRIPTION
Get a summary of the status page, including a status indicator, component statuses, unresolved incidents, and any upcoming or in-progress scheduled maintenances.
Get the status rollup for the whole page. This endpoint includes an indicator - one of none, minor, major, or critical, as well as a human description of the blended component status. Examples of the blended status include "All Systems Operational", "Partial System Outage", and "Major Service Outage".
Get a summary of the status page, including a status indicator, component statuses, unresolved incidents,
and any upcoming or in-progress scheduled maintenances. Get the status rollup for the whole page. This endpoint
includes an indicator - one of none, minor, major, or critical, as well as a human description of the blended
component status. Examples of the blended status include "All Systems Operational", "Partial System Outage",
and "Major Service Outage".
.EXAMPLE
Get-GitHubStatus
Expand All @@ -15,7 +18,8 @@
.EXAMPLE
Get-GitHubStatus -Summary
Gets a summary of the status page, including a status indicator, component statuses, unresolved incidents, and any upcoming or in-progress scheduled maintenances.
Gets a summary of the status page, including a status indicator, component statuses, unresolved incidents,
and any upcoming or in-progress scheduled maintenances.
.NOTES
https://www.githubstatus.com/api#summary
Expand All @@ -24,7 +28,8 @@
[OutputType([pscustomobject])]
[CmdletBinding()]
param(
# Gets a summary of the status page, including a status indicator, component statuses, unresolved incidents, and any upcoming or in-progress scheduled maintenances.
# Gets a summary of the status page, including a status indicator, component statuses, unresolved incidents,
# and any upcoming or in-progress scheduled maintenances.
[Parameter()]
[switch] $Summary
)
Expand Down
3 changes: 2 additions & 1 deletion src/GitHub/public/Users/Emails/Get-GitHubUserEmail.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
.DESCRIPTION
Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.
Specifying '-Public' will return only the publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint.
Specifying '-Public' will return only the publicly visible email address, which you can set with the [Set primary email visibility for the
authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint.
.EXAMPLE
Get-GitHubUserEmail
Expand Down
7 changes: 5 additions & 2 deletions src/GitHub/public/Users/Get-GitHubUserCard.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@
Get contextual information for a user
.DESCRIPTION
Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope.
You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:
The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns
more information than without the parameters. For example, if you wanted to find out more about `octocat`
who owns the `Spoon-Knife` repository via cURL, it would look like this:
```shell
curl -u username:token
Expand Down
3 changes: 2 additions & 1 deletion src/GitHub/public/Users/Keys/Get-GitHubUserKey.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
.DESCRIPTION
Lists a given user's or the current user's public SSH keys.
For the authenticated users keys, it requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
For the authenticated users keys, it requires that you are authenticated via Basic Auth or via OAuth with
at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
Keys from a given user are accessible by anyone.
.EXAMPLE
Expand Down

0 comments on commit 49475db

Please sign in to comment.