Skip to content

Param tags doc#402

Open
psprint wants to merge 1 commit into
zdharma-continuum:mainfrom
psprint:param-tags-doc
Open

Param tags doc#402
psprint wants to merge 1 commit into
zdharma-continuum:mainfrom
psprint:param-tags-doc

Conversation

@psprint

@psprint psprint commented Oct 26, 2022

Copy link
Copy Markdown
Contributor

Description

Document param'var→val' ice, alt-shift-q tags browser and also improve it.

Motivation and Context

I've recalled some undocumented features.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@github-actions github-actions Bot added the docs label Oct 26, 2022
jankatins
jankatins reviewed Oct 26, 2022
View reviewed changes
Comment thread README.md
| `run` `[-l]` `[plugin]` `{command}` | <div align="justify" style="text-align: justify;">Runs the given command in the given plugin's directory. If the option `-l` will be given then the plugin should be skipped – the option will cause the previous plugin to be reused.</div> |
## An embedded TAGS browser

Zinit comes via an embedded Ctags browser. Just create a `TAGS` file

@jankatins jankatins Oct 26, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are actually CTags and why would I want this feature??

@psprint psprint Oct 26, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ctags creates index of source code and allows jumping to symbols. The support in zinit is a under prompt popup menu that allows direct from shell opening $EDITOR on the symbol. The feature in merged the new PR is doc only.

@psprint psprint Oct 26, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jankatins Here's a presentation video: https://asciinema.org/a/zdUpv3oLUU2uEiCHRCEcRS2yr

@vladdoster vladdoster Nov 1, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woah, the functionality to pop into a function like that is cool

@psprint psprint Nov 22, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a docs only PR, could it be merged?

@vladdoster

vladdoster commented Nov 22, 2022

Copy link
Copy Markdown
Member

Please rebase your branch.

@psprint

psprint commented Dec 24, 2022

Copy link
Copy Markdown
Contributor Author

@vladdoster: I've rebased and fixed conflicts, please merge.

This was referenced Dec 24, 2022
Closed
Closed
@psprint psprint mentioned this pull request Feb 9, 2023
Closed
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alichtman alichtman Awaiting requested review from alichtman alichtman is a code owner
@pschmitt pschmitt Awaiting requested review from pschmitt pschmitt is a code owner
@vladdoster vladdoster Awaiting requested review from vladdoster vladdoster is a code owner
1 more reviewer
@jankatins jankatins jankatins left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@psprint @vladdoster @jankatins