Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#8979 closed (fixed)

Documentation fixes

Reported by: ramiro Owned by: nobody
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

A few issues thata haven't already been reported in other Component:Documentation tickets: reST fixes, addition of Pygmentation to some files, typos.

Attachments (1)

doc-fixes-r8985.diff (12.7 KB) - added by ramiro 6 years ago.

Download all attachments as: .zip

Change History (6)

Changed 6 years ago by ramiro

comment:1 follow-ups: Changed 6 years ago by adrian

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Note that this patch did not apply cleanly for me, as it refers to "a/docs" and "b/docs". In the future, could you do a "svn diff" from within the main "trunk" directory to produce a clean patch?

comment:2 Changed 6 years ago by adrian

  • Resolution set to fixed
  • Status changed from new to closed

(In [8987]) Fixed #8979 -- Made a bunch of typo/formatting fixes to the docs. Thanks, ramiro

comment:3 in reply to: ↑ 1 Changed 6 years ago by ramiro

Replying to adrian:

Note that this patch did not apply cleanly for me, as it refers to "a/docs" and "b/docs". In the future, could you do a "svn diff" from within the main "trunk" directory to produce a clean patch?

Problem is I don't use SVN, the patch was generated from work in a named branch in a Mercurial repository, I think git does also generates that kind of patches. See Jacob's comment here

comment:4 in reply to: ↑ 1 Changed 6 years ago by telenieko

Replying to adrian:

Note that this patch did not apply cleanly for me, as it refers to "a/docs" and "b/docs". In the future, could you do a "svn diff" from within the main "trunk" directory to produce a clean patch?


Tip: "patch -p1 < diff-file.diff"

The "-pN" parameter means "Strip the smallest prefix containing num leading slashes...", so, in this case would mean "Strip b/ and a/". It defaults to "-p0" ;)

Git, Mercurial, even doing diff by hand (i.e. when using a release tarball) will generate diff with those prefix, then "-p1" does the job ;)

comment:5 Changed 6 years ago by adrian

Looks like I missed the Cool Kids' memo about Git patches. Thanks for the pointer!

Note: See TracTickets for help on using tickets.
Back to Top