Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/api-docs-check.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Missing API docs
on:
pull_request:
pull_request_target:
types: [opened, synchronize, reopened, ready_for_review]
branches-ignore:
- 'marvim/api-doc-update**'
Expand All @@ -18,3 +18,6 @@ jobs:
uses: ./.github/workflows/api-docs.yml
with:
check_only: true
# The 'pull_request_target' event has $GITHUB_SHA as the last commit of
# the PR base branch (neovim/master), we need the actual PR branch HEAD
ref: ${{ github.event.pull_request.head.sha }}
5 changes: 5 additions & 0 deletions .github/workflows/api-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ on:
type: boolean
default: false
required: false
ref:
type: string
default: ''
required: true

jobs:
regen-api-docs:
Expand All @@ -31,6 +35,7 @@ jobs:
- uses: actions/checkout@v2
with:
fetch-depth: 0
ref: ${{ inputs.ref || env.GITHUB_SHA }}

- name: Install dependencies
run: |
Expand Down
8 changes: 4 additions & 4 deletions runtime/doc/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3492,9 +3492,9 @@ nvim_del_augroup_by_id({id}) *nvim_del_augroup_by_id()*

To get a group id one can use |nvim_get_autocmds()|.

NOTE: behavior differs from |augroup-delete|. When deleting a
group, autocommands contained in this group will also be
deleted and cleared. This group will no longer exist.
NOTE: behavior really differs from |augroup-delete|. When
deleting a group, autocommands contained in this group will
also be deleted and cleared. This group will no longer exist.

Parameters: ~
{id} Integer The id of the group.
Expand Down Expand Up @@ -3592,7 +3592,7 @@ nvim_get_autocmds({*opts}) *nvim_get_autocmds()*
• group_name (string): the autocommand group name.
• desc (string): the autocommand description.
• event (string): the autocommand event.
• command (string): the autocommand command.
the command (string): the autocommand command.
• once (boolean): whether the autocommand is only run
once.
• pattern (string): the autocommand pattern. If the
Expand Down
4 changes: 2 additions & 2 deletions src/nvim/api/autocmd.c
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ static int64_t next_autocmd_id = 1;
/// - group_name (string): the autocommand group name.
/// - desc (string): the autocommand description.
/// - event (string): the autocommand event.
/// - command (string): the autocommand command.
/// - the command (string): the autocommand command.
/// - once (boolean): whether the autocommand is only run once.
/// - pattern (string): the autocommand pattern.
/// If the autocommand is buffer local |autocmd-buffer-local|:
Expand Down Expand Up @@ -706,7 +706,7 @@ Integer nvim_create_augroup(uint64_t channel_id, String name, Dict(create_augrou
///
/// To get a group id one can use |nvim_get_autocmds()|.
///
/// NOTE: behavior differs from |augroup-delete|. When deleting a group, autocommands contained in
/// NOTE: behavior really differs from |augroup-delete|. When deleting a group, autocommands contained in
/// this group will also be deleted and cleared. This group will no longer exist.
/// @param id Integer The id of the group.
/// @see |nvim_del_augroup_by_name()|
Expand Down