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

Remove yard plugin and generate last minor version documentation #138

Merged
merged 4 commits into from
Apr 8, 2020

Conversation

benoittgt
Copy link
Member

This plugin add extra steps when people want to generate documentation. We do not want to use Google Analytics anymore + we prefer to use the default header and footer from Yard that is optimized for mobile.

Copy link
Member

@pirj pirj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just glanced over, but let's merge. The less deviations from mainline rendering the better. 👍

Copy link
Member

@JonRowe JonRowe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So mostly this looks like changes dropping the charset stuff and the google analytics scripts but its also been generated from the wrong version, so theres unintentional changes here too, I've flagged things I think are wrong version, some just seem to be spacing changes did you run your script on this? Apologies for the terse comments in places, but I wanted to flag every bad file...

<span class='object_link'><a href="RSpec/Matchers.html#include-instance_method" title="RSpec::Matchers#include (method)">#include</a></span>
<small>RSpec::Matchers</small>
<span class='object_link'><a href="RSpec/Matchers/BuiltIn/RespondTo.html#ignoring_method_signature_failure!-instance_method" title="RSpec::Matchers::BuiltIn::RespondTo#ignoring_method_signature_failure! (method)">#ignoring_method_signature_failure!</a></span>
<small>RSpec::Matchers::BuiltIn::RespondTo</small>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes don't look like spacing changes... :S

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is some reordering. I don't no why but it doesn't seem to have impact in method list.

Capture d’écran 2020-04-08 à 12 32 13

Use rspec/rspec-dev#247

To avoid a big diff, empty line removal is commented

```diff
--- a/Rakefile
+++ b/Rakefile
@@ -81,7 +81,7 @@ task :update_docs, [:version, :branch, :website_path] do |t, args|

     Bundler.unbundled_system %Q{ag -l src=\\"\\\(?:..\/\\\)*js #{doc_destination_path} | xargs -I{} sed #{in_place} 's/src="\\\(..\\\/\\\)*js/src="\\\/documentation\\\/#{args[:version]}\\\/#{project}\\\/js/' {}}
     Bundler.unbundled_system %Q{ag -l href=\\"\\\(?:..\/\\\)*css #{doc_destination_path} | xargs -I{} sed #{in_place} 's/href="\\\(..\\\/\\\)*css/href="\\\/documentation\\\/#{args[:version]}\\\/#{project}\\\/css/' {}}
-    Bundler.unbundled_system %Q{ag --html -l . #{doc_destination_path} | xargs -I{} sed #{in_place} /^[[:space:]]*$/d {}}
+    # Bundler.unbundled_system %Q{ag --html -l . #{doc_destination_path} | xargs -I{} sed #{in_place} /^[[:space:]]*$/d {}}
```


<span class="summary_desc"><div class='inline'><p>Used by other matchers to suppress a check.</p>
</div></span>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

16
17
18
19</pre>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change included in 3.9.1

<span class='kw'>end</span></pre>
</td>
</tr>
</table>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change included in 3.9.1


<h3>3.9.0 / 2019-10-08</h3>

<p><a href="http://github.com/rspec/rspec-expectations/compare/v3.8.6...v3.9.0">Full Changelog</a></p>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be better now.

<span class='object_link'><a href="RSpec/Matchers.html#include-instance_method" title="RSpec::Matchers#include (method)">#include</a></span>
<small>RSpec::Matchers</small>
<span class='object_link'><a href="RSpec/Matchers/BuiltIn/RespondTo.html#ignoring_method_signature_failure!-instance_method" title="RSpec::Matchers::BuiltIn::RespondTo#ignoring_method_signature_failure! (method)">#ignoring_method_signature_failure!</a></span>
<small>RSpec::Matchers::BuiltIn::RespondTo</small>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is some reordering. I don't no why but it doesn't seem to have impact in method list.

Capture d’écran 2020-04-08 à 12 32 13

@benoittgt benoittgt force-pushed the no-plugin-from-source branch from 003568d to 4a6ff3a Compare April 8, 2020 16:12
@benoittgt benoittgt marked this pull request as ready for review April 8, 2020 16:14
@benoittgt benoittgt changed the title Remove yard plugin Remove yard plugin and generate last minor version documentation Apr 8, 2020
@JonRowe
Copy link
Member

JonRowe commented Apr 8, 2020

Looks good now!

Copy link
Member

@pirj pirj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Scrolled all the way down, everything looks good 👍

@benoittgt
Copy link
Member Author

Thanks! I need to buy you a new trackpad now... 😄

@benoittgt benoittgt merged commit 26111c7 into source Apr 8, 2020
@benoittgt benoittgt deleted the no-plugin-from-source branch April 8, 2020 23:10
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

Successfully merging this pull request may close these issues.

3 participants