Skip to content

Remove nvim version from generated docs #116

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 27, 2025
Merged

Remove nvim version from generated docs #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions lib/neovim/buffer.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

module Neovim
# Class representing an +nvim+ buffer.
#
# The methods documented here were generated using NVIM v0.11.1
class Buffer < RemoteObject
attr_reader :lines

Expand Down
2 changes: 0 additions & 2 deletions lib/neovim/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ module Neovim
# +RemoteObject+ subclasses (i.e. +Buffer+, +Window+, or +Tabpage+),
# which similarly have dynamically generated interfaces.
#
# The methods documented here were generated using NVIM v0.11.1
#
# @see Buffer
# @see Window
# @see Tabpage
Expand Down
2 changes: 0 additions & 2 deletions lib/neovim/tabpage.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

module Neovim
# Class representing an +nvim+ tabpage.
#
# The methods documented here were generated using NVIM v0.11.1
class Tabpage < RemoteObject
# The following methods are dynamically generated.
=begin
Expand Down
2 changes: 0 additions & 2 deletions lib/neovim/window.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

module Neovim
# Class representing an +nvim+ window.
#
# The methods documented here were generated using NVIM v0.11.1
class Window < RemoteObject
# Get the buffer displayed in the window
#
Expand Down
5 changes: 0 additions & 5 deletions script/generate_docs.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
window_docs = []
tabpage_docs = []
nvim_exe = ENV.fetch("NVIM_EXECUTABLE", "nvim")
nvim_vrs = %x(#{nvim_exe} --version).split("\n").first

event_loop = Neovim::EventLoop.child([nvim_exe, "-u", "NONE", "-n"])
session = Neovim::Session.new(event_loop)
Expand Down Expand Up @@ -83,10 +82,6 @@
doc_str = ["=begin", *docs, "=end"].join("\n")

contents.sub!(/=begin.+=end/m, doc_str)
contents.sub!(
/# The methods documented here were generated using .+$/,
"# The methods documented here were generated using #{nvim_vrs}"
)

File.write(path, contents)
end