Skip to content

Fixes for #53#57

Merged
DrKJeff16 merged 3 commits into
mainfrom
patch/documentation
Aug 6, 2025
Merged

Fixes for #53#57
DrKJeff16 merged 3 commits into
mainfrom
patch/documentation

Conversation

@DrKJeff16

Copy link
Copy Markdown
Owner

Changes

Same as #53 plus the following:

  • Enclosed hyperlinks in markdown format
  • Added missing punctuation to as many descriptions as possible.

Signed-off-by: Guennadi Maximov C <g.maxc.fox@protonmail.com>
@DrKJeff16 DrKJeff16 force-pushed the patch/documentation branch from 7ffc46a to 17fc406 Compare August 5, 2025 19:43
Signed-off-by: Guennadi Maximov C <g.maxc.fox@protonmail.com>
@DrKJeff16 DrKJeff16 added documentation Improvements or additions to documentation enhancement New feature or request needs-review A PR labeled with this is in need of review labels Aug 5, 2025
@DrKJeff16 DrKJeff16 added the work-in-progress This is yet to be finished label Aug 5, 2025
Comment thread lua/types/config.lua
Comment on lines +1132 to +1136
--- ---
---Note that blinking is no longer a binary blink, but interpolates
---between invisible and visible text using an easing function.
---See `text_blink_rapid_ease_in` and `text_blink_rapid_ease_out`
---for more information.

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.

I don't know what to do about these 'Notes' parts where Wez is giving an update about how things have changed from previous versions. I've just been incorporating those notes into the docs because I don't like having to read all the way to bottom of the documentation page to see what the 'latest' change to this option/value is, I'd rather see that up front. My opinion is that when we see these sort of 'update for version 2024...' additions, we just incorporate those notes and adjust the annotations/docs accordingly. What do you think? This can be a TODO for sometime later, I don't want to hold up this PR for it!

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Yeah, the trick's to integrate these "version updates" seamlessly in the annotations.

I found for now just to add a horizontal ruler (---) just as a compromise,
but if we can manage to find a better solution I'm all for it.

Comment thread lua/types/config.lua
---
---@field treat_left_ctrlalt_as_altgr? boolean
---The set of unix domains
---The set of UNIX domains.

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.

Good catch! I noticed this in at least 1 or 2 other places, let's fix 'em as we see them.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

The UNIX uppercase?

Comment thread lua/types/config.lua
--- ---
---Note that blinking is no longer a binary blink, but interpolates
---between invisible and visible text using an easing function.
---See `text_blink_rapid_ease_in` and `text_blink_rapid_ease_out`

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.

Another TODO maybe: I haven't tried them yet but I wonder if we could make use of the referring to symbols feature so they could be clickable links? I'm not sure if they even work in neovim or how they render, just a thought!

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Does this feature apply to ---@field annotations?

@craigmac craigmac left a comment

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.

Looks great thanks! I'll open the possible TODOs as separate issues.

@DrKJeff16 DrKJeff16 merged commit 596e528 into main Aug 6, 2025
1 check passed
@DrKJeff16 DrKJeff16 deleted the patch/documentation branch August 6, 2025 05:12
@DrKJeff16

Copy link
Copy Markdown
Owner Author

@craigmac Oh man, just when we were talking about Neovim's renderng: this happens lol

@craigmac

craigmac commented Aug 6, 2025

Copy link
Copy Markdown
Contributor

@craigmac Oh man, just when we were talking about Neovim's renderng: this happens lol

Interesting! I'll watch it's progress.

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

Labels

documentation Improvements or additions to documentation enhancement New feature or request needs-review A PR labeled with this is in need of review work-in-progress This is yet to be finished

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants