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

Docs for Capybara::Node::Element#click not created correctly #2777

Open
sbungartz opened this issue Oct 7, 2024 · 0 comments
Open

Docs for Capybara::Node::Element#click not created correctly #2777

sbungartz opened this issue Oct 7, 2024 · 0 comments

Comments

@sbungartz
Copy link

Hi, thanks for maintaining this fantastic library!

I just noticed a little issue with the Documentation of the Capybara::Node::Element#click-Method, where some information is present in the docstring but does not get rendered to the Rubydoc documentation. I'm not too familiar with the syntax, but I could imagine this to be a quick fix.

Meta

Capybara Version: master

Expected Behavior

The information about the :x and :y options that is present in the docstring (referencing the differences in behaviour depending on the w3c_click_offset setting) should show up in the generated rubydoc documentation.

Docstring here:

##
#
# Click the Element.
#
# @macro action_waiting_behavior
# @!macro click_modifiers
# Both x: and y: must be specified if an offset is wanted, if not specified the click will occur at the middle of the element.
# @overload $0(*modifier_keys, wait: nil, **offset)
# @param *modifier_keys [:alt, :control, :meta, :shift] ([]) Keys to be held down when clicking
# @option options [Integer] x X coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the
# offset will be from the element center, otherwise it will be from the top left corner of the element
# @option options [Integer] y Y coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the
# offset will be from the element center, otherwise it will be from the top left corner of the element
# @option options [Float] delay Delay between the mouse down and mouse up events in seconds (0)
# @return [Capybara::Node::Element] The element

Actual Behavior

Options :x and :y are not shown in rubydoc at https://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Node/Element#click-instance_method

image

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