Skip to content

Commit

Permalink
Remove /en slug in docs.github.com links (and stop VSCode from form…
Browse files Browse the repository at this point in the history
…atting on save) (#2573)
  • Loading branch information
SeanKilleen authored Sep 20, 2022
1 parent 063e85e commit 05aa951
Show file tree
Hide file tree
Showing 43 changed files with 175 additions and 174 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,20 @@ jobs:
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs

# Details on CodeQL's query packs refer to : https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality


# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2

# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# 📚 See https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

# If the Autobuild fails above, remove it and uncomment the following three lines.
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# - run: |
Expand Down
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"editor.formatOnSave": false,
"files.exclude": {
"**/bin": true,
"**/obj": true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public interface IObservableEnterpriseClient
/// A client for GitHub's Enterprise Pre-receive Hooks API
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#pre-receive-hooks">Enterprise Pre-receive Hooks API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#pre-receive-hooks">Enterprise Pre-receive Hooks API documentation</a> for more information.
///</remarks>
IObservableEnterprisePreReceiveHooksClient PreReceiveHook { get; }
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ namespace Octokit.Reactive
/// A client for GitHub's Enterprise Pre-receive Hooks API
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#pre-receive-hooks">Enterprise Pre-receive Hooks API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#pre-receive-hooks">Enterprise Pre-receive Hooks API documentation</a> for more information.
///</remarks>
public interface IObservableEnterprisePreReceiveHooksClient
{
/// <summary>
/// Gets all <see cref="PreReceiveHook"/>s.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#list-pre-receive-hooks">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#list-pre-receive-hooks">API documentation</a> for more information.
/// </remarks>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
IObservable<PreReceiveHook> GetAll();
Expand All @@ -24,7 +24,7 @@ public interface IObservableEnterprisePreReceiveHooksClient
/// Gets all <see cref="PreReceiveHook"/>s.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#list-pre-receive-hooks">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#list-pre-receive-hooks">API documentation</a> for more information.
/// </remarks>
/// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
Expand All @@ -34,7 +34,7 @@ public interface IObservableEnterprisePreReceiveHooksClient
/// Gets a single <see cref="PreReceiveHook"/>.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#get-a-pre-receive-hook">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#get-a-pre-receive-hook">API documentation</a> for more information.
/// </remarks>
/// <param name="hookId">The id of the pre-receive hook</param>
/// <exception cref="NotFoundException">Thrown when the specified <paramref name="hookId"/> does not exist.</exception>
Expand All @@ -45,7 +45,7 @@ public interface IObservableEnterprisePreReceiveHooksClient
/// Creates a new <see cref="PreReceiveHook"/>.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#create-a-pre-receive-hook">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#create-a-pre-receive-hook">API documentation</a> for more information.
/// </remarks>
/// <param name="newPreReceiveHook">A description of the pre-receive hook to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
Expand All @@ -55,7 +55,7 @@ public interface IObservableEnterprisePreReceiveHooksClient
/// Edits an existing <see cref="PreReceiveHook"/>.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#update-a-pre-receive-hook">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#update-a-pre-receive-hook">API documentation</a> for more information.
/// </remarks>
/// <param name="hookId">The id of the pre-receive hook</param>
/// <param name="updatePreReceiveHook">A description of the pre-receive hook to edit</param>
Expand All @@ -67,7 +67,7 @@ public interface IObservableEnterprisePreReceiveHooksClient
/// Deletes an existing <see cref="PreReceiveHook"/>.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#delete-a-pre-receive-hook">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#delete-a-pre-receive-hook">API documentation</a> for more information.
/// </remarks>
/// <param name="hookId">The id of the pre-receive hook</param>
/// <exception cref="NotFoundException">Thrown when the specified <paramref name="hookId"/> does not exist.</exception>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public ObservableEnterpriseClient(IGitHubClient client)
/// A client for GitHub's Enterprise Pre-receive Hooks API
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#pre-receive-hooks">Enterprise Pre-receive Hooks API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#pre-receive-hooks">Enterprise Pre-receive Hooks API documentation</a> for more information.
///</remarks>
public IObservableEnterprisePreReceiveHooksClient PreReceiveHook { get; private set; }
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace Octokit.Reactive
/// A client for GitHub's Enterprise Pre-receive Hooks API
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#pre-receive-hooks">Enterprise Pre-receive Hooks API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#pre-receive-hooks">Enterprise Pre-receive Hooks API documentation</a> for more information.
///</remarks>
public class ObservableEnterprisePreReceiveHooksClient : IObservableEnterprisePreReceiveHooksClient
{
Expand All @@ -28,7 +28,7 @@ public ObservableEnterprisePreReceiveHooksClient(IGitHubClient client)
/// Gets all <see cref="PreReceiveHook"/>s.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#list-pre-receive-hooks">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#list-pre-receive-hooks">API documentation</a> for more information.
/// </remarks>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
public IObservable<PreReceiveHook> GetAll()
Expand All @@ -40,7 +40,7 @@ public IObservable<PreReceiveHook> GetAll()
/// Gets all <see cref="PreReceiveHook"/>s.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#list-pre-receive-hooks">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#list-pre-receive-hooks">API documentation</a> for more information.
/// </remarks>
/// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
Expand All @@ -55,7 +55,7 @@ public IObservable<PreReceiveHook> GetAll(ApiOptions options)
/// Gets a single <see cref="PreReceiveHook"/>.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#get-a-pre-receive-hook">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#get-a-pre-receive-hook">API documentation</a> for more information.
/// </remarks>
/// <param name="hookId">The id of the pre-receive hook</param>
/// <exception cref="NotFoundException">Thrown when the specified <paramref name="hookId"/> does not exist.</exception>
Expand All @@ -69,7 +69,7 @@ public IObservable<PreReceiveHook> Get(long hookId)
/// Creates a new <see cref="PreReceiveHook"/>.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#create-a-pre-receive-hook">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#create-a-pre-receive-hook">API documentation</a> for more information.
/// </remarks>
/// <param name="newPreReceiveHook">A description of the pre-receive hook to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
Expand All @@ -84,7 +84,7 @@ public IObservable<PreReceiveHook> Create(NewPreReceiveHook newPreReceiveHook)
/// Edits an existing <see cref="PreReceiveHook"/>.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#update-a-pre-receive-hook">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#update-a-pre-receive-hook">API documentation</a> for more information.
/// </remarks>
/// <param name="hookId">The id of the pre-receive hook</param>
/// <param name="updatePreReceiveHook">A description of the pre-receive hook to edit</param>
Expand All @@ -101,7 +101,7 @@ public IObservable<PreReceiveHook> Edit(long hookId, UpdatePreReceiveHook update
/// Deletes an existing <see cref="PreReceiveHook"/>.
/// </summary>
/// <remarks>
/// See the <a href="https://docs.github.com/en/enterprise-server/rest/reference/enterprise-admin#delete-a-pre-receive-hook">API documentation</a> for more information.
/// See the <a href="https://docs.github.com/enterprise-server/rest/reference/enterprise-admin#delete-a-pre-receive-hook">API documentation</a> for more information.
/// </remarks>
/// <param name="hookId">The id of the pre-receive hook</param>
/// <exception cref="NotFoundException">Thrown when the specified <paramref name="hookId"/> does not exist.</exception>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public interface IObservableCommitCommentReactionsClient
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The comment id</param>
/// <param name="number">The comment id</param>
/// <returns></returns>
IObservable<Reaction> GetAll(string owner, string name, int number);

Expand All @@ -58,7 +58,7 @@ public interface IObservableCommitCommentReactionsClient
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment</remarks>
/// <param name="repositoryId">The owner of the repository</param>
/// <param name="number">The comment id</param>
/// <param name="number">The comment id</param>
/// <returns></returns>
IObservable<Reaction> GetAll(long repositoryId, int number);

Expand All @@ -75,7 +75,7 @@ public interface IObservableCommitCommentReactionsClient
/// <summary>
/// Deletes a reaction for a specified Commit Comment
/// </summary>
/// <remarks>https://docs.github.com/en/rest/reactions#delete-a-commit-comment-reaction</remarks>
/// <remarks>https://docs.github.com/rest/reactions#delete-a-commit-comment-reaction</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="commentId">The comment id</param>
Expand All @@ -86,7 +86,7 @@ public interface IObservableCommitCommentReactionsClient
/// <summary>
/// Deletes a reaction for a specified Commit Comment
/// </summary>
/// <remarks>https://docs.github.com/en/rest/reactions#delete-a-commit-comment-reaction</remarks>
/// <remarks>https://docs.github.com/rest/reactions#delete-a-commit-comment-reaction</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="commentId">The comment id</param>
/// <param name="reactionId">The reaction id</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public interface IObservableIssueCommentReactionsClient
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The comment id</param>
/// <param name="number">The comment id</param>
IObservable<Reaction> GetAll(string owner, string name, int number);

/// <summary>
Expand All @@ -46,15 +46,15 @@ public interface IObservableIssueCommentReactionsClient
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The comment id</param>
/// <param name="options">Options for changing the API response</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Reaction> GetAll(string owner, string name, int number, ApiOptions options);

/// <summary>
/// List reactions for a specified Issue Comment
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The comment id</param>
/// <param name="number">The comment id</param>
IObservable<Reaction> GetAll(long repositoryId, int number);

/// <summary>
Expand All @@ -63,13 +63,13 @@ public interface IObservableIssueCommentReactionsClient
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The comment id</param>
/// <param name="options">Options for changing the API response</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Reaction> GetAll(long repositoryId, int number, ApiOptions options);

/// <summary>
/// Deletes a reaction for a specified Issue Comment
/// </summary>
/// <remarks>https://docs.github.com/en/rest/reactions#delete-an-issue-comment-reaction</remarks>
/// <remarks>https://docs.github.com/rest/reactions#delete-an-issue-comment-reaction</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="commentId">The comment id</param>
Expand All @@ -80,7 +80,7 @@ public interface IObservableIssueCommentReactionsClient
/// <summary>
/// Deletes a reaction for a specified Commit Comment
/// </summary>
/// <remarks>https://docs.github.com/en/rest/reactions#delete-an-issue-comment-reaction</remarks>
/// <remarks>https://docs.github.com/rest/reactions#delete-an-issue-comment-reaction</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="commentId">The comment id</param>
/// <param name="reactionId">The reaction id</param>
Expand Down
Loading

0 comments on commit 05aa951

Please sign in to comment.