Skip to content

Update note.md with modern test and documentation commands #237

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

Closed
kojix2 wants to merge 2 commits into from
Closed

Update note.md with modern test and documentation commands #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e20b053
Updated note.md with modern test commands
kojix2 Jun 1, 2025
70a9f78
Update note.md with modern documentation commands
kojix2 Jun 1, 2025
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
7 changes: 7 additions & 0 deletions Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,10 @@ source 'https://rubygems.org'

# Specify your gem's dependencies in narray-devel.gemspec
gemspec

group :development do
gem 'rake', '>= 12.3.3'
gem 'rake-compiler', '~> 1.1'
gem 'test-unit'
gem 'yard'
end
21 changes: 9 additions & 12 deletions doc/note.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
# Miscellaneous notes for Numo::NArray

## Running RSpec
## Running Tests

(in advance, install gem with --development option)
```shell
# All tests
bundle exec rake test

```shell
$ "${HOME}/.gem/ruby/2.?/bin/rspec" "${HOME}/.gem/ruby/2.?/gems/numo-narray-0.9.?.?/spec/bit_spec.rb"
$ "${HOME}/.gem/ruby/2.?/bin/rspec" "${HOME}/.gem/ruby/2.?/gems/numo-narray-0.9.?.?/spec/narray_spec.rb"
# Specific test
bundle exec ruby test/narray_test.rb
bundle exec ruby test/bit_test.rb
```

## YARD documents generation

(in advance, install yard gem)

```shell
$ cd "${HOME}/.gem/ruby/2.?/gems/numo-narray-0.9.?.?/ext/numo/narray"
$ make doc
yard doc *.c types/*.c
...
```shell
bundle exec rake doc
```
4 changes: 0 additions & 4 deletions numo-narray.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,4 @@ Gem::Specification.new do |spec|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
spec.require_paths = ["lib"]
spec.extensions = ["ext/numo/narray/extconf.rb"]

spec.add_development_dependency "rake", ">= 12.3.3"
spec.add_development_dependency "rake-compiler", "~> 1.1"
spec.add_development_dependency "test-unit"
end
Loading