Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DM-10146 Fix minor doc typos #8

Merged
merged 5 commits into from
Apr 18, 2017
Merged

DM-10146 Fix minor doc typos #8

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ed2e527
Change `astshim::` to `ast::` in two comments
r-owen Apr 7, 2017
56e9e57
Expand FrameSet::removeFrame docs
r-owen Apr 13, 2017
bc6589d
Fix redundant @ref Frame Frame -> @ref Frame
r-owen Apr 13, 2017
698dc53
Enable links to FrameSet::BASE and CURRENT
r-owen Apr 13, 2017
ea907c3
Fix Matrix Coefficients link in PolyMap docs
r-owen Apr 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion include/astshim/FrameSet.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,10 @@ friend class Object;
};

/**
Remove a @ref Frame Frame from a @ref FrameSet
Remove a @ref Frame Frame from a @ref FrameSet.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These @ref tags are redundant.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for spotting this. I changed @ref Frame Frame to @ref Frame in the only two places I found it. I would dearly love to get rid of all unnecessary @ref tags, which I think means all those that do not specify alternate text for the link, such as @ref Frame "Frames". However, I have not thought of a suitable grep expression or script. Suggestions welcome.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect the vast majority of @ref tags are unnecessary, so just searching for all of them might be faster than devising a script.

I assume you left the @ref here for forward-compatibility with such a script?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically that's the case. I left it in for consistency with the rest of the documentation.

I agree that links such as @ref Frame "Frames" could probably be changed to Frames with little harm done. However, references to properties and other sorts of anchors really do benefit from having the link text specified, and there are a lot of those. Furthermore, any link that specifies link text needs more than just deleting @ref, since doing that would leave the a word followed by the desired link text behind.


All other Frames in the FrameSet have their indices re-numbered from one (if necessary),
but are otherwise unchanged.

@param[in] iframe The index of the required @ref Frame Frame within this @ref FrameSet.
This value should lie in the range 1 to the number of @ref Frame "Frames"
Expand Down
4 changes: 2 additions & 2 deletions include/astshim/Object.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ friend class MapSplit;
}

/**
Given a bare AST object pointer return a shared pointer to an astshim::Object of the correct type
Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type

The returned object takes ownership of the pointer. This is almost always what you want,
for instance astDecompose returns shallow copies of the internal pointers.
Expand Down Expand Up @@ -277,7 +277,7 @@ friend class MapSplit;
}

/**
Given a bare AST object pointer return a shared pointer to an astshim::Object of the correct type
Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type

The returned object takes ownership of the pointer. This is almost always what you want,
for instance astDecompose returns shallow copies of the internal pointers.
Expand Down
4 changes: 2 additions & 2 deletions include/astshim/WcsMap.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,15 +184,15 @@ friend class Object;

### Examples

- `auto wcsmap = astshim::WcsMap(2, WcsType::MER, 1, 2, "")`
- `auto wcsmap = ast::WcsMap(2, WcsType::MER, 1, 2, "")`

Create a WcsMap that implements a FITS-WCS Mercator
projection on pairs of coordinates, with coordinates 1 and 2
representing the longitude and latitude respectively. Note
that the FITS-WCS Mercator projection does not require any
projection parameters.

- `auto wcsmap = astshim::WcsMap(3, WcsType::COE, 2, 3, "PV3_1=40.0")`
- `auto wcsmap = ast::WcsMap(3, WcsType::COE, 2, 3, "PV3_1=40.0")`

Create a WcsMap that implements a FITS-WCS conical equal
area projection. The WcsMap acts on points in a 3-dimensional
Expand Down