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

Update Templates.md to fix incorrect path structure #1588

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

topherfangio
Copy link

Description

Fix incorrect path structure in "Overriding Templates by Registering a Template Path" section.

Because of the YARD::Templates::Engine.register_template_path '/path/to/mytemplates' code above, we need a default subdirectory to contain the class/html/customsection.erb and class/setup.rb files.

The paragraph immediately after this even mentions the default/class structure, but I missed it since it wasn't in the tree structure.

Tested with yard 0.9.36 to verify.

Completed Tasks

  • I have read the Contributing Guide.
  • The pull request is complete (implemented / written).
  • Git commits have been cleaned up (squash WIP / revert commits).
  • I wrote tests and ran bundle exec rake locally (if code is attached to PR).

Fix incorrect path structure in "Overriding Templates by Registering a Template Path" section.
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.

1 participant