Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update list of currently available settings #2583

Merged
merged 2 commits into from
May 22, 2024

Conversation

ekorchmar
Copy link
Contributor

Not all of the available settings are currently listed, as documentation suggests.

  • Fork: important, as recent release changed the default behaviour and command line option is worded differently; had to dive into the code to find it.
  • Theme: another recently added option.
  • Font: provided a (default) example to better explain the expected format.

What kind of change does this PR introduce?

  • Documentation

Did this PR introduce a breaking change?

A breaking change includes anything that breaks backwards compatibility either at compile or run time.

  • No

Not all of the settings were listed.
* Fork: important, as recent release changed the default behaviour and
command line option is worded differently; this documented only in code.
* Theme: another recently added option
* Font: just an example to better explain the expected format
idle = true
neovim-bin = "/usr/bin/nvim" # in reality found dynamically on $PATH if unset
frame = "full"
theme = "auto"
title-hidden = true
tabs = true
Copy link
Member

Choose a reason for hiding this comment

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

Could you sort this and the settings in config.rs alphabetically. That way the order is less random, and it's easier to compare.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in ab188aa. Local cargo test also ran successfully after the change. Can never be too safe

Copy link

Test Results

  6 files  ±0    6 suites  ±0   20s ⏱️ -4s
110 tests ±0  110 ✅ ±0  0 💤 ±0  0 ❌ ±0 
644 runs  ±0  644 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ab188aa. ± Comparison against base commit a5b5ae6.

@fredizzimo fredizzimo merged commit d20c912 into neovide:main May 22, 2024
13 checks passed
@fredizzimo
Copy link
Member

Thank you!

zbyna pushed a commit to zbyna/neovide that referenced this pull request Jun 1, 2024
* docs: Update list of currently available settings

Not all of the settings were listed.
* Fork: important, as recent release changed the default behaviour and
command line option is worded differently; this documented only in code.
* Theme: another recently added option
* Font: just an example to better explain the expected format

* Reorder config options naturally in code and docs
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