-
-
Notifications
You must be signed in to change notification settings - Fork 155
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
Version 0.39.6 #322
Comments
Since you recommend installing a fresh documentation for the latest core I'd like to ask you if it's really important that core documentation matches the Ruby runtime version. Should we provide all cores? |
It doesn't have to be an exact match, especially if the difference is only in the minor version. Nevertheless, I'll update the online docs later this week. (Versions to be added: 2.5.8, 2.6.6, and 2.7.1) |
Is it sufficient to instruct Rubygems to generate Yard documentation on every install? Or do we need to run |
RubyGems should automatically generate YARD documentation when you install the gem. If you want to make sure it's configured to do so, you can enable it with this:
It doesn't hurt to run |
The latest Solargraph release has some significant changes.
I highly recommend resetting your cache by running these commands:
You can also improve documentation in specific projects by going to the project root and running:
The
solargraph bundle
command is especially useful for Rails apps. It makes sure yardocs are available for all your gems, and also generates more complete yardocs for certain gems likeactiverecord
that use RDoc syntax instead of YARD. For some projects,solargraph bundle
won't need to do anything, but it doesn't hurt to run it.The cache makes Solargraph start significantly faster, so you should only run
clear
if you think there's a problem with it. Thebundle
command is non-destructive by default, so it should be safe to run if you just want to make sure you have all the gem docs you need.The text was updated successfully, but these errors were encountered: