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

[Feature request] attribute YARD documentation for solargraph support #720

Open
Samsinite opened this issue Jan 13, 2020 · 7 comments
Open

Comments

@Samsinite
Copy link

Hi, love this gem, been using it for years.

Recently, I started using the solargraph ruby language server in my editor, which uses YARD documentation to provide intellisense like features for ruby projects. Is there any interest in adding support for this to annotate_models? If not, do you have any recommendations on the best approach to build an extension to this gem to assist with generating that documentation?

Cheers!

@tvallois
Copy link
Contributor

Hi,

I'm currently working on an implementation of this but i don't know if there is any interest here in adding yard support...

@Samsinite
Copy link
Author

@tvallois would you be interested in assistance if support for documentation can be added?

@Samsinite
Copy link
Author

Samsinite commented Jan 22, 2020

Ah I may have misunderstood, it looks like you meant that you are working on adding support for yard, but you weren't sure if the maintainers were interested in adding yard support. Would you be interested in collaborating?

@tvallois
Copy link
Contributor

hi @Samsinite,
there is already a pull request on this #724
Yeah we can collaborate to improve this.

@tvallois
Copy link
Contributor

I've tried to use the develop version of this project in our rails app using YARD but i have an error

Unable to annotate app/models/preview.rb: undefined method `map_col_type_to_ruby_classes' for AnnotateModels:Module

Any idea @Samsinite @drwl ?

@drwl
Copy link
Collaborator

drwl commented Feb 1, 2020

@tvallois Can you run it with --trace?

@tvallois
Copy link
Contributor

tvallois commented Feb 3, 2020

tvallois@tvallois-G3-3579:~/enlaps/enlaps-web$ bundle exec bin/rake db:migrate --trace
Running via Spring preloader in process 14460
** Invoke db:migrate (first_time)
** Invoke db:load_config (first_time)
** Invoke environment (first_time)
** Execute environment
** Execute db:load_config
** Execute db:migrate
** Invoke db:_dump (first_time)
** Execute db:_dump
** Invoke db:schema:dump (first_time)
** Invoke db:load_config 
** Execute db:schema:dump
** Invoke set_annotation_options (first_time)
** Execute set_annotation_options
** Invoke annotate_models (first_time)
** Invoke set_annotation_options 
** Invoke environment 
** Execute annotate_models
Unable to annotate app/models/user.rb: undefined method `map_col_type_to_ruby_classes' for AnnotateModels:Module
Unable to annotate app/models/user.rb: no implicit conversion of nil into Array

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants