Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
* remove stray comma in generated docs
* small improvements to clarity
* regenerated autodocs for latest libvips

see #97
  • Loading branch information
jcupitt committed Jan 30, 2017
1 parent 0b7d3ad commit 66a8e5a
Show file tree
Hide file tree
Showing 6 changed files with 210 additions and 146 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,11 @@
# master

# Version 1.0.4

* remove stray comma from some docs lines [John Cupitt]
* update generated docs for libvips 8.5 [John Cupitt]
* small doc improvements [John Cupitt]

# Version 1.0.3

* doc improvements [John Cupitt]
Expand Down
48 changes: 0 additions & 48 deletions TODO
@@ -1,26 +1,5 @@
# Notes

- travis needs fixing, we have this is 0.3

rvm:
- 1.9.3
- 2.0
- 2.1
script: "rake"
gemfile:
- Gemfile
before_install:
- uname -a
- sudo apt-get update
- sudo apt-get install libvips-dev
before_script:
- ./compile

- need something like the old ruby-vips occasional GC stuff, we can fill
memory before a GC is triggered

need a test case

- mail about the getpoint unimplemented error

http://sourceforge.net/p/ruby-gnome2/mailman/ruby-gnome2-devel-en/thread/CAGNS0RuZ5N6bha3M7B0%2BYf2M9-oni44idzZO17mtQiykS%2BmJKQ%40mail.gmail.com/#msg34790843
Expand All @@ -32,33 +11,6 @@
Complex(1, 2)
=> (1+2i)

- fix travis ... the difficulty is getting a libvips with goi built first,
perhaps copy-paste from libvips .travis.yml

this is almost enough to do the ruby side:

----------
env:
global:
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true

language: ruby
rvm:
- 2.1
- 2.2
- 2.3

script: "bundle exec rake"

gemfile:
- Gemfile

before_install:
- uname -a
- sudo apt-get update
- sudo apt-get install libvips-dev
-----------

# Common operations

- version bump
Expand Down
2 changes: 1 addition & 1 deletion VERSION
@@ -1 +1 @@
1.0.3
1.0.4
23 changes: 13 additions & 10 deletions lib/vips/image.rb
Expand Up @@ -421,10 +421,11 @@ def self.method_missing(name, *args)
# $ vips jpegload
# ```
#
# at the command-line to see a summary of the available options.
# at the command-line to see a summary of the available options for the
# JPEG loader.
#
# Loading is fast: only enough of the image is loaded to be able to fill
# out the header. Pixels will only be processed when they are needed.
# out the header. Pixels will only be decompressed when they are needed.
#
# @!macro [new] vips.loadopts
# @param [Hash] opts set of options
Expand All @@ -451,8 +452,8 @@ def self.new_from_file(name, opts = {})
Vips::call_base loader, nil, option_string, [filename, opts]
end

# Create a new {Image} for an image encoded in a format, such as
# JPEG, in a memory string. Load options may be passed encoded as
# Create a new {Image} for an image encoded, in a format such as
# JPEG, in a memory string. Load options may be passed as
# strings, or appended as a hash. For example:
#
# ```
Expand All @@ -471,11 +472,12 @@ def self.new_from_file(name, opts = {})
# $ vips jpegload_buffer
# ```
#
# at the command-line to see the available options. Only JPEG, PNG and
# TIFF images can be read from memory buffers.
# at the command-line to see the available options. Not all loaders
# support load from buffer, but at least JPEG, PNG and
# TIFF images will work.
#
# Loading is fast: only enough of the image is loaded to be able to fill
# out the header. Pixels will only be processed when they are needed.
# out the header. Pixels will only be decompressed when they are needed.
#
# @param data [String] the data to load from
# @param option_string [String] load options as a string
Expand Down Expand Up @@ -574,7 +576,7 @@ def self.new_from_array(array, scale = 1, offset = 0)
# $ vips jpegsave
# ```
#
# to see all the available options.
# to see all the available options for JPEG save.
#
# @!macro [new] vips.saveopts
# @param [Hash] opts set of options
Expand Down Expand Up @@ -616,7 +618,7 @@ def write_to_file(name, opts = {})
# $ vips jpegsave
# ```
#
# to see all the available options.
# to see all the available options for JPEG save.
#
# @param format_string [String] save format plus options
# @macro vips.saveopts
Expand Down Expand Up @@ -1352,7 +1354,8 @@ def self.generate_yard
print "self." if not member_x
print "#{nickname}("
print required_input.map(&:name).join(", ")
puts ", opts = {})"
print ", " if required_input.length > 0
puts "opts = {})"

puts "# #{op.description.capitalize}."

Expand Down

0 comments on commit 66a8e5a

Please sign in to comment.