fixed issues in docs

usethesource · Oct 17, 2024 · 8242a47 · 8242a47
1 parent 3a7782c
commit 8242a47
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 9 deletions.
diff --git a/doc/Tutor/Markup/InlineMarkup/Image/Image.md b/doc/Tutor/Markup/InlineMarkup/Image/Image.md
@@ -53,10 +53,8 @@ which produces this:
 
 <img src="/assets/Tutor/Markup/InlineMarkup/Image/dandelion.jpg" width="100px"/>
 
-
-(((TODO: uncomment the next link after bootstrapping
-<!-- Finally, have a look at the Library:module:Content library module and the listing feature to generate
-images using Rascal code at Tutor compile time. -->)))
+Finally, have a look at the Library:module:Content library module and the listing feature to generate
+images using Rascal code at Tutor compile time.
 
 #### Benefits
 

diff --git a/doc/Tutor/Markup/InlineMarkup/LinkingConcepts/LinkingConcepts.md b/doc/Tutor/Markup/InlineMarkup/LinkingConcepts/LinkingConcepts.md
@@ -57,10 +57,8 @@ We can create a reference to the `InlineMarkup` concept in the current course in
 * `((Markup-InlineMarkup))` (using its parent concept name and concept name) gives ((Markup-InlineMarkup)).
 * `[see inline markup]((Tutor:Markup-InlineMarkup))` gives [see inline markup]((Tutor:Markup-InlineMarkup))
 
-(((TODO: uncomment the reference
-<!-- Here is a reference to another course:
-
-* `[Prelude collection]\(\(Library:Prelude\)\)` gives [Prelude collection]\(\(Library:Prelude\)\). -->)))
+Here is a reference to another course:
+* `[Prelude collection]\(\(Library:Prelude\)\)` gives [Prelude collection]\(\(Library:Prelude\)\).
 
 #### Benefits
 

diff --git a/src/lang/rascal/tutor/apidoc/ExtractInfo.rsc b/src/lang/rascal/tutor/apidoc/ExtractInfo.rsc
@@ -219,6 +219,7 @@ rel[str, DocTag] getTagContents(Tags tags){
 list[DocTag] sortedDocTags(rel[str, DocTag] tags) 
   = [ *tags["doc"],
       *tags["synopsis"],
+      *tags["deprecated"],
       *tags["syntax"],
       *tags["types"],
       *tags["details"],

diff --git a/src/lang/rascal/tutor/apidoc/GenerateMarkdown.rsc b/src/lang/rascal/tutor/apidoc/GenerateMarkdown.rsc
@@ -121,7 +121,8 @@ list[Output] declInfo2Doc(str parent, d:moduleInfo(), list[str] overloads, PathC
 list[Output] declInfo2Doc(str parent, d:functionInfo(), list[str] overloads, PathConfig pcfg, CommandExecutor exec, Index ind, list[str] dtls, bool demo) =
     [
         out("## function <d.name> {<moduleFragment(d.moduleName)>-<d.name>}"),
-        *[Output::empty(), out(synopsis.content) | synopsis:docTag(label="synopsis") <- d.docs],
+        empty(),
+        *[out(defLine) | str defLine <- split("\n", d.synopsis)],
         empty(),
         out("```rascal"),
         *([ *[out(defLine) | str defLine <- split("\n", ov)], empty() | ov <- overloads][..-1]),