docs: implement feedback

modules/fontane/edited-text/etTransfo.xqm

@@ -106,8 +106,8 @@ declare function etTransfo:transform-single-nb($uri as xs:string) as xs:string*
  : Resolves all XIncludes in a given case file and copies all notebooks belonging
  : to a case into one XML file.
  :
- : This is mainly used to be able to serialize one case at a time which has been
- : a requirement of the scholars.
+ : This is mainly used to be able to serialize one case at a time which is
+ : a project requirement.
  :
  : @author Michelle Weidling
  : @param $showcase The filename of a showcase, e.g. "12345.xml"
@@ -333,8 +333,8 @@ declare function etTransfo:get-literature() as element(tei:div) {
  : An auxiliary function to create the tei:div elements/sections in the bibliography.
  :
  : @author Michelle Weidling
- : @param $identifier An identifier for a sub-type of scholarly literature, e.g. "Briefausgaben"
- : @return A tei:div containing all bibliographic information of the literature's sub-type
+ : @param $identifier An identifier for a subtype of scholarly literature, e.g. "Briefausgaben"
+ : @return A tei:div containing all bibliographic information of the literature's subtype
  :)
 declare function local:make-bib-div($identifier as xs:string) as element(tei:div) {
     element {QName("http://www.tei-c.org/ns/1.0", "div")} {
@@ -507,7 +507,7 @@ declare function etTransfo:report-errors() as item()* {
 
 
 (:~
- : Creates the overall TOC by collection information from all "Überblickskommentare".
+ : Creates the overall TOC by collecting information from all "Überblickskommentare".
  : This info is needed for a separate kind of index in the book.
  :
  : This feature is still in development and has to be extended to work with all

modules/fontane/edited-text/tidy.xqm

@@ -2,7 +2,7 @@ xquery version "3.1";
 
 (:~
  : This modules handles the conversion of the Fontante-TEI/XML into a TEI subset
- : for the edited text. The resulting TEI is the basis for the "Editerter
+ : for the edited text. The resulting TEI is the basis for the "Edierter
  : Text" (edited text) view on the website and the book. It represents the latest
  : layer of text.
  : 
@@ -78,8 +78,8 @@ as node()* {
                 else
                     $node
     
-            (: all lines have to be preserved because of the editorial commentary
-            which references the lines in the notebooks. if we omitted @unit = "line"
+            (: All lines have to be preserved because of the editorial commentary
+            which references the lines in the notebooks. If we omitted @unit = "line",
             referencing wouldn't work any longer :)
             case element(tei:milestone) return
                 if($node/@unit = "handshift" and
@@ -158,8 +158,6 @@ as node()* {
         case text() return
             $node
 
-        (: in the following typeswitch, the same constructor appears several
-        times. we decided not to :)
         case element(tei:milestone) return
             if($node/@unit = "handshift") then
                 if(simpleHelpers:is-prev-hand-same($node)) then
@@ -212,8 +210,9 @@ as node()* {
 };
 
 (:~
- : Since we have a bunch of elements that potentially lost their content in
- : the sorting process, the default return checks for any content.
+ : As a result of the previous sorting process, certain elements may be empty
+ : at this process stage. They don't have any information value anymore and are
+ : therefore removed.
  :)
 declare function tidy:surplus-elements-default-return($node as node())
 as element() {