Skip to content

Conversation

@bf4
Copy link
Member

@bf4 bf4 commented Jan 6, 2016

Just for review, right now. Merging would require editing in various
places.

Generated by

export RAILS_VERSION=master
bundle exec rails plugin new . --full --mountable --api --skip-spring
--skip-sprockets --skip-javascript --skip-gemfile --skip-git

and some editing...

Ref: dummy server setup in #1412
for how we could pare down the dummy app if we wanted to

Just for review, right now. Merging would require editing in various
places.

Generated by

export RAILS_VERSION=master
bundle exec rails plugin new . --full --mountable --api --skip-spring
--skip-sprockets --skip-javascript --skip-gemfile --skip-git

and some editing...
@bf4
Copy link
Member Author

bf4 commented Jan 6, 2016

I know there's a bunch of stuff commented out or duplicated.. just focus on what the changes would be and what they'd mean, at this point, rather than if they're complete

Copy link
Member Author

Choose a reason for hiding this comment

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

yard of course

# encoding: utf-8

require 'yard'

namespace :yard do
  YARD::Rake::YardocTask.new(:doc) do |t|
    t.stats_options = ['--list-undoc']
  end

  desc 'start a gem server'
  task :server do
    sh 'bundle exec yard server --gems'
  end

  desc 'use Graphviz to generate dot graph'
  task :graph do
    output_file = 'doc/erd.dot'
    sh "bundle exec yard graph --protected --full --dependencies > #{output_file}"
    puts 'open doc/erd.dot if you have graphviz installed'
  end
end

bf4 referenced this pull request in remear/active_model_serializers Feb 26, 2016
@remear
Copy link
Member

remear commented Mar 17, 2016

Is this something we want to pursue?

@bf4
Copy link
Member Author

bf4 commented Mar 18, 2016

I think we should....

B mobile phone

On Mar 17, 2016, at 1:21 PM, Ben Mills notifications@github.com wrote:

Is this something we want to pursue?


You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub

@bf4
Copy link
Member Author

bf4 commented Jun 9, 2016

This is particular useful if we move our fixtures and controllers etc to the dummy app to both improve code organization and document an example app

@NullVoxPopuli
Copy link
Contributor

This is particular useful if we move our fixtures and controllers etc to the dummy app to both improve code organization and document an example app

So if someone had a bug they wanted to report, they could fork this project, try to re-create the issue in here, and open a PR, proving the bug exists?

I think this would be a great way to have runnable examples, too.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants