Ivy
  1. Ivy
  2. IVY-1222

Grammar, spelling, clarity, and consistency of Tutorial documentation.

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.2.0-RC1
    • Fix Version/s: 2.3.0-RC1
    • Component/s: Documentation
    • Labels:
      None

      Description

      The tutorial documentation desperately needed editing. This patch focuses mainly on spelling, grammar, and clarity to improve the experience of people learning and trying out Ivy. I also tried to use consistent markup and capitalization throughout. The next step would be to actually write up a standards document, that defines the standard conventions for documentation. The docs still need work, but this is a huge step in the right direction. The patch also includes some updates to the resolver documentation that I forgot to include in the patch IVY-1216.

        Activity

        Hide
        Gilles Scokart added a comment -

        Thanks a lot,
        Don't hesitate to post other grammar, spelling and clarity documentation patches.

        Show
        Gilles Scokart added a comment - Thanks a lot, Don't hesitate to post other grammar, spelling and clarity documentation patches.

          People

          • Assignee:
            Unassigned
            Reporter:
            Steve Miller
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development