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

Avoid HTML comment preamble in man page output from Pandoc #399

Merged
merged 4 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 0 additions & 4 deletions .rubocop-bundler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ Lint/AssignmentInCondition:
Lint/UnusedMethodArgument:
Enabled: false

Lint/UriEscapeUnescape:
Enabled: true


# Style

Layout/EndAlignment:
Expand Down
16 changes: 8 additions & 8 deletions docs/gemstash-configuration.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,10 +221,10 @@ Boolean values `true` or `false`
`:fetch_timeout`

This is the number of seconds to allow for fetching a gem from upstream.
It covers establishing the connection and receiving the response. Fetching
gems over a slow connection may cause timeout errors. If you experience
timeout errors, you may want to increase this value. The default is `20`
seconds.
It covers establishing the connection and receiving the response.
Fetching gems over a slow connection may cause timeout errors. If you
experience timeout errors, you may want to increase this value. The
default is `20` seconds.

## Default value

Expand All @@ -239,10 +239,10 @@ Integer value with a minimum of `1`
`:open_timeout`

The timeout setting for opening the connection to an upstream gem
server. On high-latency networks, even establishing the connection
to an upstream gem server can take a while. If you experience
connection failures instead of timeout errors, you may want to
increase this value. The default is `2` seconds.
server. On high-latency networks, even establishing the connection to an
upstream gem server can take a while. If you experience connection
failures instead of timeout errors, you may want to increase this value.
The default is `2` seconds.

## Default value

Expand Down
2 changes: 1 addition & 1 deletion docs/gemstash-private-gems.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Stashing private gems in your Gemstash server requires a bit of
additional setup. If you haven’t read through the [Quickstart
Guide](../README.md#quickstart-guide), you should do that first. By the
Guide](../readme.md#quickstart-guide), you should do that first. By the
end of this guide, you will be able to interact with your Gemstash
server to store and retrieve your private gems.

Expand Down
2 changes: 1 addition & 1 deletion lib/gemstash/env.rb
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ def db
db = if RUBY_PLATFORM == "java"
Sequel.connect("jdbc:sqlite:#{db_path}", config.database_connection_config)
else
Sequel.connect("sqlite://#{CGI.escape(db_path)}", config.database_connection_config)
Sequel.connect("sqlite://#{db_path}", config.database_connection_config)
end
when "postgres", "mysql", "mysql2"
db_url = config[:db_url]
Expand Down
3 changes: 2 additions & 1 deletion rakelib/doc.rake
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ class Doc
content = ::File.read(to_file)
content.gsub!("](./", "](docs/")
content.gsub!(/\A---(.|\n)*?---/, "")
::File.write to_file, "<!-- Automatically generated by Pandoc -->\n#{content}"
prefix = format == "man" ? "" : "<!-- Automatically generated by Pandoc -->\n"
::File.write to_file, "#{prefix}#{content}"
end

def export_path(dir, filename)
Expand Down