SX Spring Actionscript
  1. SX Spring Actionscript
  2. SESPRINGACTIONSCRIPTAS-69

Spring Actionscript extensions documentation improvements

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 0.8.1
    • Fix Version/s: 0.9
    • Component/s: None
    • Labels:
      None

      Description

      While reading through the Spring Actionscript extensions documentation (http://www.springactionscript.org/docs/reference/html/extensions-documentation.html) I found a minor grammatical error and a suggestion for improving the documentation:

      1) The first sentence of the second paragraph of section 3.1.1.1 contains a small grammatical error: "its" is used where it should be "it's" since then sentence intends to use the contraction of "it is" rather than the self referring possessive.
      So the sentence
      To circumvent this problem its a good plan to...
      Should be:
      To circumvent this problem it's a good plan to...

      2) Section 3.1.1.1 contains two example object configurations that show singletons being configured by setting the singleton attribute to true. Section 2.1.6.1. "The singleton scope" and section 2.1.6.2. "The prototype scope" indicate that use of the scope attribute is preferred and recommended over using the singleton attribute. Additionally, several of the other example configurations in Section 3 use the scope attribute to create singleton objects. As such, those two example object configurations, and a text entry referencing one of them, should probably be changed to use the scope attribute.

      I have attached a patch to the src/docbkx/extensions-documentation.xml file containing the recommended changes.

        Activity

        Hide
        Roland Zwaga added a comment -

        Fixed in the trunk

        Show
        Roland Zwaga added a comment - Fixed in the trunk

          People

          • Assignee:
            Roland Zwaga
            Reporter:
            Mark Vedder
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: