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

Allow #+, #-, #' to be cross referenced #632

Merged
merged 2 commits into from
Jun 23, 2018

Conversation

TheSmartnik
Copy link
Contributor

Hi 👋

This small pr allows for methods like #+, #-, #* to be cross referenced.

This, for example, will improve ruby documentation. See Array#concat documentation


I'd be happy to added tests with a little guidance on where this regex is currently tested

@TheSmartnik TheSmartnik force-pushed the improve_cross_reference_regex branch 3 times, most recently from 4a5bfd0 to 8d91cf3 Compare June 23, 2018 16:22
@TheSmartnik
Copy link
Contributor Author

@aycabta tests seem to randomly fail on random versions.
Don't really think that this code is anything to do with this, but would love to hear your opinion

@aycabta
Copy link
Member

aycabta commented Jun 23, 2018

@TheSmartnik Thank you for your reporting. The random failure of CI is fixed by #631.

I'd be happy to added tests with a little guidance on where this regex is currently tested

First, please add example code for it to test/xref_data.rb and test/xref_test_case.rb. Maybe, you should add C1#+ and @c1_plus. Finally, please add assesion(s) to TestRDocCrossReference#test_resolve_method of test/test_rdoc_cross_reference.rb.

@TheSmartnik TheSmartnik force-pushed the improve_cross_reference_regex branch from 8d91cf3 to 0e65554 Compare June 23, 2018 19:29
@TheSmartnik
Copy link
Contributor Author

@aycabta thanks for help! Added tests and rebased on master. All green now

@aycabta aycabta merged commit c642102 into ruby:master Jun 23, 2018
@aycabta
Copy link
Member

aycabta commented Jun 23, 2018

@TheSmartnik OK, thank you. I think that this feature is very important for documentation. I'm glad you propose this.

@TheSmartnik TheSmartnik deleted the improve_cross_reference_regex branch June 23, 2018 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants