[Biojava-l] More documentation typos

[Tony Watkins]

Package org.biojava.bio.gui

Description

(original)
...This maintains consistent API even when the user sees very different images.

(suggested correction)
This maintains *a* consistent API even when the user sees very different images.

Interface LogoPainter

(original)
... It is given the StateLog to render, so that a single LogoPainter can be shaired among many state logos.

(suggested correction)
It is given the StateLog to render, so that a single LogoPainter can be *shared* among many state logos.

Interface SymbolStyle

(original)
Given a symbol, this allows you to get the color to outline or fill the glyphs for rendering the symbol. This may be something as simple as coloring dots on a scatter-plot, or labeling a key, or it may be as complicated as sequence logos.

(Suggested UK correction, please ignore if not appropriate)

Given a symbol, this allows you to get the *colour* to outline or fill the glyphs for rendering the symbol. This may be something as simple as *colouring* dots on a scatter-plot, or labeling a key, or it may be as complicated as sequence logos.

Class DistributionLogo

(original)
The gui component for rendering a DistributionLogo. By default, this uses the text logo style - with letters stacked on top of one another, scaled by the total information in the dist, and uses a PlainStyle colorer that outlines in black, and fills in grey

(suggested correction)
The *GUI* component for rendering a DistributionLogo. By default, this uses the text logo style - with letters stacked on top of one another, scaled by the total information in the *distribution*, and uses a PlainStyle *colourer* that outlines in black, and fills in grey

Package org.biojava.bio.gui.sequence

Interface SequenceRenderContext

A context within sequence which information may be rendered.

(I have no clue what this actually means but it doesn't appear to read correctly in terms of grammar.  Does the following suggestion make any sense?)

*A context within a sequence for which information may be rendered.*

Class AbstractBeadRenderer

(original)
AbstractBeadRenderer is a an abstract base class for the creation of FeatureRenderers which use a 'string of beads' metaphor for displaying features

(suggested correction)
AbstractBeadRenderer is *an* abstract base class for the creation of FeatureRenderers which use a 'string of beads' metaphor for displaying features

Class CrosshairRenderer

(original)
... The crosshair it set to a sequence position by a click and then stays there through scrolls/rescales until the next click.

(suggested correction)

...The crosshair *is* set to a sequence position by a click ...

Class OverlayRendererWrapper

(original)
This class wraps SequenceRenderer classes to present an an Overlay Marker interface that will indicate to LayeredRenderer that subsequent renderers should overdraw the same space as the wrapped renderer.

(suggested correction)
This class wraps SequenceRenderer classes to present *an* Overlay Marker interface that will indicate to LayeredRenderer that subsequent renderers should overdraw the same space as the wrapped renderer.

Class PairwiseFilteringRenderer

(original)
... The renderer recieves a new PairwiseRenderContext which has had both of its FeatureHolders filtered with the FeatureFilter.

(suggested correction)

The renderer *receives* a new PairwiseRenderContext which has had both of its FeatureHolders filtered with the FeatureFilter.

Class PairwiseSequencePanel

(original)
... This could be anything from traditional dotplots (or variants created with lines) to more complex layered plot involving superimposed renderers.

(suggested corrections)

either
This could be anything from traditional dotplots (or variants created with lines) to more complex layered *plots* involving superimposed renderers.

or
This could be anything from traditional dotplots (or variants created with lines) to *a* more complex layered plot involving superimposed renderers.

That's all for now folks.

Have a better one....