Skip to content

Add documentation for some actions#587

Closed
TC72 wants to merge 5 commits intonvim-telescope:masterfrom
TC72:help-docs
Closed

Add documentation for some actions#587
TC72 wants to merge 5 commits intonvim-telescope:masterfrom
TC72:help-docs

Conversation

@TC72
Copy link
Copy Markdown
Contributor

@TC72 TC72 commented Mar 2, 2021

Just a first try at adding some documentation to see if I'm doing this right.

@TC72 TC72 changed the title Added documentation for some actions Add documentation for some actions Mar 2, 2021
@Conni2461
Copy link
Copy Markdown
Member

I am not sure why docgen didn't run for you. I can't see the actions on your fork so. You need open your fork repo, go to actions, and look at docgen output.

You can also just try to retrigger CI. git commit --amend, just save and force push

@TC72
Copy link
Copy Markdown
Contributor Author

TC72 commented Mar 2, 2021

When I looked at actions it showed there weren't any workflows being run so I enabled them.
I've pushed again and it looks like the action "Generate docs" ran.

https://github.com/TC72/telescope.nvim/actions/workflows/docgen.yml

@Conni2461
Copy link
Copy Markdown
Member

Nice, we still have issues that only the last x queries are exported but this bug was fixed in tree-sitter and we need to wait until neovim works with that version, until then, this will not generate docs for all function. You can still continue to document but and we can retrigger CI when these issues are sorted out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants