Commit c8302b2f authored by Reuben Pereira's avatar Reuben Pereira

Correct the comments above the ProjectReferenceFilter#project_link_filter...

Correct the comments above the ProjectReferenceFilter#project_link_filter function to make it clear that the full project path is required in a reference.
parent 07ac9ee2
...@@ -44,13 +44,13 @@ module Banzai ...@@ -44,13 +44,13 @@ module Banzai
doc doc
end end
# Replace `project>` project references in text with links to the referenced # Replace `namespace/project>` project references in text with links to the referenced
# project page. # project page.
# #
# text - String text to replace references in. # text - String text to replace references in.
# link_content - Original content of the link being replaced. # link_content - Original content of the link being replaced.
# #
# Returns a String with `project>` references replaced with links. All links # Returns a String with `namespace/project>` references replaced with links. All links
# have `gfm` and `gfm-project` class names attached for styling. # have `gfm` and `gfm-project` class names attached for styling.
def project_link_filter(text, link_content: nil) def project_link_filter(text, link_content: nil)
self.class.references_in(text) do |match, project_path| self.class.references_in(text) do |match, project_path|
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment