Menu

#4925 Don't use @code inside of @example

Verified
Documentation
2016-08-02
2016-07-09
No

Don't use @code inside of @example

@example is already set in monospace font (use @display if you don't
want to change fonts). This replacement was done mechanically using
the script

sed -i '/@example *$/,/@end example *$/{s/@code{\(\([^@}]\|@[@{}]\)*\)}/\1/g;s/ \+$//;}' $(git grep -l '^@end example$' Documentation)

so not all replacements are really formatted best. But overall this
looks like an improvement.

http://codereview.appspot.com/304810043

Discussion

  • Anonymous

    Anonymous - 2016-07-09
    • Description has changed:

    Diff:

    
    
    • Needs: -->
    • Patch: new --> review
     
  • Anonymous

    Anonymous - 2016-07-09

    Passes make, make check and a full make doc.

     
  • David Kastrup

    David Kastrup - 2016-07-10
    • Type: Enhancement --> Documentation
     
  • Anonymous

    Anonymous - 2016-07-11
    • Patch: review --> countdown
     
  • Anonymous

    Anonymous - 2016-07-11

    Patch on countdown for July 14th.

     
  • Anonymous

    Anonymous - 2016-07-14

    Patch counted down - please push

     
  • David Kastrup

    David Kastrup - 2016-07-15
    • labels: --> Fixed_2_19_46
    • status: Started --> Fixed
    • Patch: countdown -->
     
  • David Kastrup

    David Kastrup - 2016-07-15

    Pushed to staging as
    commit db92af51a444062c8edaef3afa36f57375b8feeb
    Author: David Kastrup dak@gnu.org
    Date: Fri Jul 8 21:41:54 2016 +0200

    Issue 4925: Don't use @code inside of @example
    
    @example is already set in monospace font (use @display if you don't
    want to change fonts).  This replacement was done mechanically using
    the script
    
        sed -i '/@example *$/,/@end example *$/{s/@code{\(\([^@}]\|@[@{}]\)*\)}/\1/g;s/ \+$//;}' $(git grep -l '^@end example$' Documentation)
    
    so not all replacements are really formatted best.  But overall this
    looks like an improvement.
    
     
  • Phil Holmes

    Phil Holmes - 2016-08-02
    • status: Fixed --> Verified