Skip to content

Commit

Permalink
Docs typo fixes related to array_view
Browse files Browse the repository at this point in the history
  • Loading branch information
lgritz committed Jan 12, 2019
1 parent 8421ef8 commit d988904
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
8 changes: 4 additions & 4 deletions src/doc/imageioapi.tex
Original file line number Diff line number Diff line change
Expand Up @@ -286,12 +286,12 @@ \section{Non-owning string views: {\cf string_view}}


\section{Non-owning array views: {\cf span} / {\cf cspan}}
\label{sec:span} \label{sec:arrayview}
\label{sec:span}
\indexapi{span} \index{cspan} \indexapi{array_view}

{\bf Note:} {\cf span} and \arrayview are synonyms. The new preferred name is
{\bf Note:} {\cf span} and {\cf array_view} are synonyms. The new preferred name is
{\cf span}, in keeping with the equivalent template that has been accepted into
future C++ standards. But the old name \arrayview is still accepted. Over
future C++ standards. But the old name {\cf array_view} is still accepted. Over
time, we will eventually update the documentation to reflect the change.
% DEPRECATED 2.0

Expand All @@ -307,7 +307,7 @@ \section{Non-owning array views: {\cf span} / {\cf cspan}}
could instead take a {\cf span<const T>}. As a shorthand, {\cf cspan<T>} is
defined as a synonym to {\cf span<const T>}, they are equivalent.

For historical reasons, the deprecated name \arrayview is accepted as a
For historical reasons, the deprecated name {\cf array_view} is accepted as a
synonym for {\cf span}. (But will eventually be removed.)

A {\cf span} may be initialized explicitly from a pointer and length, by
Expand Down
1 change: 0 additions & 1 deletion src/doc/openimageio.tex
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@
\def\readtile{{\codefont read\_tile()}\xspace}
\def\AutoStride{{\codefont AutoStride}\xspace}
\def\cspan{{\codefont cspan}\xspace}
\def\arrayview{{\codefont span}\xspace}
\def\stringview{{\codefont string\_view}\xspace}
\def\ustring{{\codefont ustring}\xspace}

Expand Down

0 comments on commit d988904

Please sign in to comment.