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

Incomplete documentation generated via robot.libdoc (YARD::Registry loses load data) #3

Open
lumendes opened this issue Oct 23, 2017 · 0 comments

Comments

@lumendes
Copy link

lumendes commented Oct 23, 2017

Hi,
Not sure if this is still actually being maintained, but here is goes :)
I don't seem to be able to get full documentation (missing args and ruby comments) via robot.libdoc.

Environment:

Ubuntu 16.04
ruby-2.4.1
yard (0.9.9)
robot_remote_server (2.5.6)

TestServer.rb:

require 'robot_remote_server'
class TestServer
   #Keyword documentation
   def keyword(value)
      puts "Hello " + value + " !"
   end
end

if __FILE__ == $0
  RobotRemoteServer.new(TestServer::new, host='localhost', port=8270)
end

YARD docs generated from same path:
yardoc TestServer.rb

Serving:
ruby TestServer.rb

Robot docs generation:
python -m robot.libdoc Remote::http://127.0.0.1:8270 test.html

Result:
Keyword args and comments info missing from test.hmlt file.

Workaround
I am not familiar with Ruby, but a workaround I've found was to modify robot_remote_server.rb source file with additional load and force caching in get_keyword_arguments method:

def get_keyword_arguments(name)
   ++ @reg.load!()
   (...)
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

1 participant