Skip to content

Commit

Permalink
Update compound mapping docs
Browse files Browse the repository at this point in the history
The documentation for CmpMap, SeriesMap and ParallelMap
was incorrect regarding the effects of the latter two
being a wrapper around the first.
  • Loading branch information
r-owen committed Jan 30, 2018
1 parent 1cda08a commit 5696338
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
4 changes: 4 additions & 0 deletions include/astshim/CmpMap.h
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ way.
### Attributes
@ref CmpMap has no attributes beyond those provided by @ref Mapping and @ref Object.
@warning CmpMap will sometimes appears as a SeriesMap or ParallelMap, as appropriate, including:
- getClassName() will return "SeriesMap" or "ParallelMap", as appropriate
- A CmpMap persisted using a Channel or pickle will be unpersisted as a SeriesMap or ParallelMap
*/
class CmpMap : public Mapping {
friend class Object;
Expand Down
5 changes: 4 additions & 1 deletion include/astshim/ParallelMap.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ component in forming further @ref ParallelMap "ParallelMaps".
@ref Mapping "Mappings" of arbitrary complexity may be built from simple
individual @ref Mapping "Mappings" in this way.
@warning This wraps AST's AstCmpMap, so getClassName() returns "CmpMap".
@warning ParallelMap is a convenience wrapper around CmpMap. Specialized code hides some
of this, so getClassName() will return "ParallelMap" and an ParallelMap persisted using a Channel
or pickle will be returned as a "ParallelMap" in Python. However, it will be visible in
other ways, such as the output from show().
### Attributes
Expand Down
5 changes: 4 additions & 1 deletion include/astshim/SeriesMap.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ Since a SeriesMap is itself a Mapping, it can be used as a
component in forming further @ref SeriesMap "SeriesMaps". @ref Mapping "Mappings" of arbitrary
complexity may be built from simple individual @ref Mapping "Mappings" in this way.
@warning This wraps AST's AstCmpMap, so getClassName() returns "CmpMap".
@warning SeriesMap is a convenience wrapper around CmpMap. Specialized code hides some
of this, so getClassName() will return "SeriesMap" and an SeriesMap persisted using a Channel
or pickle will be returned as a "SeriesMap" in Python. However, it will be visible in
other ways, such as the output from show().
### Attributes
Expand Down

0 comments on commit 5696338

Please sign in to comment.