Still active?

[jcouball]

@p0deje

Is this project still active... if it receives contributions, would someone review them?

If not, I could help out as a contributor.

I like this project and find it helpful. I have worked on open source for some years.

[p0deje]

@jcouball I'm no longer using this project in my work. Happy to add you as a contributor. Can you tell a bit more about your yard-doctest usage?

[jcouball]

Hello @p0deje, thank you for responding. Sorry I took so long getting back to you.

Thank you for writing the yard-doctest gem! I was tickled to find it because I am soooo tired of my YARD examples suffering from entropy. As you probably know, incorrect docs are worse than no docs.

I had integrated the yard-doctest gem into a project that has a lot of examples. It was pretty easy to integrate.

The hardest part of the integration was when there were errors. Due to limitations in the information available from YARD, errors are sometimes obtuse. Errors were sometimes caused by my mistake (which is why I got this gem in the first place) or because I needed to learn to write examples that were complete enough to run. I found the before hooks to be very useful in helping make examples that are both concise and complete -- a hard balance.

I found the Exceptions particularly vexing to deal with because you must give the complete string. This made the exceptions brittle to any changes in the message. Also it made the example line very long if the message was long. This messed up my Rubocop configuration.

I opened the yard-doctest code and found that it hasn't been maintained for quite a while. The CI build didn't work anymore (I think mostly because of changes in raised error strings coincidentally). As I looked into it, I thought that for my needs I needed to make a lot of changes, many of which would not be backward compatible.

In the end, I forked the project to create yard_example_runner. Per the license agreement, I have kept your copyright notice in the LICENSE.txt file. I also gave you and yard-doctest a shout out at the top of the project README.md.

Thank you again for the yard-doctest gem. I couldn't and wouldn't have created my gem without you first solving the hardest problems.

[p0deje]

@jcouball I think it might have been better to keep the current gem maintained, given it's in use by large companies (e.g., https://github.com/googleapis/google-cloud-ruby), but forking is ultimately your call. If you ever consider merging those, I'd be happy to work with you on that.

[jcouball]

@p0deje I'd be interested in considering merging. What would that look like?

BTW, after some thought, I renamed the project and gem to yard_example_test.

Github: yard_example_test
RubyGems: yard_example_test

I yanked the versions of yard_example_runner that I published yesterday.

[p0deje]

@jcouball How different is your project from the current state of yard-doctest? If we can work through those, we'll have mulitple PRs to get things merged, I'll add you as an owner to https://rubygems.org/gems/yard-doctest and we can make a new release.

[jcouball]

Hey, @p0deje , sorry to take so long in getting back to you. My attention has taken by some other projects I am working on. Let's leave this issue open for now. I'll analyze the situation and get back to you.