Submit patches for documentation

Collapse
This topic is closed.
X
X
Collapse
 
  • Page of 1
  • Time
  • Show
Clear All
new posts
Previous template Next
  • Kevin Walzer
    #1

    Submit patches for documentation

    What's the best way to submit patches for Python documentation at the
    SourceForge patch tracker if you are not writing LaTeX? I would like to
    submit some simple text updates. However, if I do this, I'm not clear
    what files I should run a diff against.

    Or is simply submitting the updates as a text file, with a note
    indicating which documentation files they replace, sufficient?

    --
    Kevin Walzer
    Code by Kevin
    Code by Kevin
    http://www.codebykevin.com

    Tags: None
    • Steve Holden
      #2
      Re: Submit patches for documentation

      Kevin Walzer wrote:
      What's the best way to submit patches for Python documentation at the
      SourceForge patch tracker if you are not writing LaTeX? I would like to
      submit some simple text updates. However, if I do this, I'm not clear
      what files I should run a diff against.
      >
      Or is simply submitting the updates as a text file, with a note
      indicating which documentation files they replace, sufficient?
      >
      The doc authors would much rather have plain English text than nothing,
      and are willing to do the markup themselves to incorporate wothwhile
      changes.

      regards
      Steve
      --
      Steve Holden +44 150 684 7255 +1 800 494 3119
      Holden Web LLC/Ltd http://www.holdenweb.com
      Skype: holdenweb http://del.icio.us/steve.holden
      Recent Ramblings http://holdenweb.blogspot.com

        Comment

        • Terry Reedy
          #3
          Re: Submit patches for documentation


          "Kevin Walzer" <kw@codebykevin .comwrote in message
          news:c18f7$4611 8350$4275d90a$4 081@FUSE.NET...
          | What's the best way to submit patches for Python documentation at the
          | SourceForge patch tracker if you are not writing LaTeX? I would like to
          | submit some simple text updates. However, if I do this, I'm not clear
          | what files I should run a diff against.
          |
          | Or is simply submitting the updates as a text file, with a note
          | indicating which documentation files they replace, sufficient?

          Identify the document, version (hopefully latest), and section.

          I have submitted informal 'diffs' like

          Typo: change psot to post

          Paragraph 3 is unclear. Suggest replacement with
          "qui ipsit locum....."

          tjr



            Comment

            Previous template Next
            Working...