Menu ▾ ▴

#535 Create documentation for dependencies

v1.1.x
closed
Erik Hänel
None
v1.1.2
Change Request
2020-11-02
2020-09-26
Erik Hänel
No

Use the already available procedure dependency analysis to create a common documentation for all dependent procedures in a single document. Probably it is necessary to load all dependent procedures first.

Analysis:

Loading all dependent procedures and update their Style information won't work from a single function due to the delays in the event loop. Moving all documentation generation features into a common handler, which will use the files directly makes more sense. As a consequence, basic lexing has to be done in this new handler, which will also be responsible for creating the main and styling files for LaTeX.

Implementation:

  • Implementation: The implementation was done as proposed by the analysis.
  • Revision: [r770]
  • Implementation test: Documentations from different dependency trees have been created.

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [ ] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [x] not needed
  • Language files:
    • [x] corresponding language files updated
    • [ ] not needed

Tests:

Change was tested manually and extensively. No deviations detected.

Related

Commit: [r770]

Discussion

  • Erik Hänel

    Erik Hänel - 2020-09-26
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2020-09-27
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 Use the already available procedure dependency analysis to create a common documentation for all dependent procedures in a single document. Probable it is necessary to load all depenent procedures first.
+
+###Analysis:
+(*Describe, what's the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you've changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**

+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2020-09-27
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
-Use the already available procedure dependency analysis to create a common documentation for all dependent procedures in a single document. Probable it is necessary to load all depenent procedures first.
+Use the already available procedure dependency analysis to create a common documentation for all dependent procedures in a single document. Probably it is necessary to load all dependent procedures first.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+Loading all dependent procedures and update their Style information won't work from a single function due to the delays in the event loop. Moving all documentation generation features into a common handler, which will use the files directly makes more sense. As a consequence, basic lexing has to be done in this new handler, which will also be responsible for creating the main and styling files for LaTeX.

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2020-10-04
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,19 +4,19 @@
 Loading all dependent procedures and update their Style information won't work from a single function due to the delays in the event loop. Moving all documentation generation features into a common handler, which will use the files directly makes more sense. As a consequence, basic lexing has to be done in this new handler, which will also be responsible for creating the main and styling files for LaTeX.

 ###Implementation:
-* Implementation: (*Describe, what you've changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: The implementation was done as proposed by the analysis.
+* Revision: [r770]
+* Implementation test: Documentations from different dependency trees have been created.

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
     * [ ] corresponding documentation articles updated
     * [ ] new documentation articles created
-    * [ ] not needed
+    * [x] not needed
 * **Language files:**
-    * [ ] corresponding language files updated
+    * [x] corresponding language files updated
     * [ ] not needed

 ###Tests:
    • status: implementing --> testing
     

    Related

    Commit: [r770]

  • Erik Hänel

    Erik Hänel - 2020-11-02
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -20,4 +20,4 @@

     * [ ] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Change was tested manually and extensively. No deviations detected.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB