Skip to content

Scope classes/module properly#76

Merged
skatkov merged 4 commits into
mainfrom
hide-extra-classes
Jun 1, 2026
Merged

Scope classes/module properly#76
skatkov merged 4 commits into
mainfrom
hide-extra-classes

Conversation

@skatkov

@skatkov skatkov commented Jun 1, 2026

Copy link
Copy Markdown
Owner

fixes #75

We're adding jekyll-seo-tags as an example gem that we're building. It is simple enough, but contains a lot of interesting edge cases.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR adjusts the Markdown generator’s class/module selection so empty namespace containers and placeholder namespaces don’t get emitted into the docs/index (addressing #75), and expands the repo’s example/validation harness by vendoring and generating docs for jekyll-seo-tag as an additional real-world fixture.

Changes:

  • Add namespace/placeholder filtering logic when building the class/module doc set (skip empty namespace containers and placeholder namespaces).
  • Add vendoring + doc-generation tasks for jekyll-seo-tag, and integrate it into markdown validation + example regeneration.
  • Update/extend tests and checked-in example output to reflect the new scoping behavior.

Reviewed changes

Copilot reviewed 20 out of 22 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
lib/rdoc/generator/markdown.rb Adds “documentable” filtering (empty namespace + placeholder namespace detection) and supporting helpers.
Rakefile Adds jekyll-seo-tag vendor setup + docs tasks; integrates generation/validation into existing workflows.
README.md Updates example regeneration instructions and vendor-docs task list to include jekyll-seo-tag.
bin/generate.sh Switches example regeneration to the new rake examples:generate task.
.gitignore Ignores nested created.rid and the new vendored vendor/jekyll-seo-tag/ checkout.
test/support/rdoc.rb Adds build_rdoc_module helper for richer module/namespace test fixtures.
test/test_class_docs.rb Adds coverage targets and new tests for empty namespace + placeholder namespace skipping rules.
test/test_path_helpers.rb Updates expected path behavior to only emit nested leaf class docs (not namespace container docs).
test/test_generator.rb Aligns integration test expectations with the new “leaf-only” namespace doc emission.
example/Object.md Updates checked-in generated output (anchor IDs).
example/Bird.md Updates checked-in generated output (anchor IDs).
example/Duck.md Updates checked-in generated output (anchor IDs).
example/Waterfowl.md Updates checked-in generated output (anchor IDs).
example/jekyll-seo-tag/index.csv Adds checked-in generated index for the new jekyll-seo-tag example fixture.
example/jekyll-seo-tag/Jekyll/SeoTag.md Adds checked-in generated doc output for jekyll-seo-tag.
example/jekyll-seo-tag/Jekyll/SeoTag/AuthorDrop.md Adds checked-in generated doc output for jekyll-seo-tag.
example/jekyll-seo-tag/Jekyll/SeoTag/Drop.md Adds checked-in generated doc output for jekyll-seo-tag.
example/jekyll-seo-tag/Jekyll/SeoTag/Filters.md Adds checked-in generated doc output for jekyll-seo-tag.
example/jekyll-seo-tag/Jekyll/SeoTag/ImageDrop.md Adds checked-in generated doc output for jekyll-seo-tag.
example/jekyll-seo-tag/Jekyll/SeoTag/JSONLD.md Adds checked-in generated doc output for jekyll-seo-tag.
example/jekyll-seo-tag/Jekyll/SeoTag/JSONLDDrop.md Adds checked-in generated doc output for jekyll-seo-tag.
example/jekyll-seo-tag/Jekyll/SeoTag/UrlHelper.md Adds checked-in generated doc output for jekyll-seo-tag.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread Rakefile Outdated
Comment thread Rakefile Outdated
skatkov added 3 commits June 1, 2026 22:57
- jekyll-seo-tag markdown validation now uses strict_links: strict_vendor_links and reports skipped unresolved links.
- vendor:setup:jekyll_seo_tag now runs git fetch --tags --force before git checkout v2.8.0, making existing checkouts more reliable.
@skatkov skatkov merged commit ce74e3e into main Jun 1, 2026
4 checks passed
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.

Extra classes presented in the list

2 participants