“example goes here”

A light post for a Friday:
Now that the FIRST robotics season is over, I think back to some documentation that says “example goes here.” Or our personal favorite to laugh at: a very serious description that says to carefully follow all the settings in the picture. Immediately followed by “picture goes here”.

I thought of this because I came across something in the PMD plugin:

 
      <documentation>
         [Enter extension point usage example here.]
      </documentation>
... 
    <documentation>
         [Enter API information here.]
      </documentation>

I think this meant by the Eclipse developers to show what a plugin looks like. To me, it’s a nice reminder to proofread what you develop.