summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/physunits
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-03-27 03:01:30 +0000
committerNorbert Preining <norbert@preining.info>2020-03-27 03:01:30 +0000
commit6c0ddfe655a39b71d1ab6a4a95d57a7ea0d94243 (patch)
tree65567ae2d29e1e8af56375fccfc1debc19b190c5 /macros/latex/contrib/physunits
parent2bd4f7f317b392c32ce18c70d03fd5ba9ddd9e6d (diff)
CTAN sync 202003270301
Diffstat (limited to 'macros/latex/contrib/physunits')
-rw-r--r--macros/latex/contrib/physunits/CHANGELOG.md20
-rw-r--r--macros/latex/contrib/physunits/physunits.dtx75
-rw-r--r--macros/latex/contrib/physunits/physunits.pdfbin100908 -> 105018 bytes
3 files changed, 81 insertions, 14 deletions
diff --git a/macros/latex/contrib/physunits/CHANGELOG.md b/macros/latex/contrib/physunits/CHANGELOG.md
index 5ccb30dc10..d61164e263 100644
--- a/macros/latex/contrib/physunits/CHANGELOG.md
+++ b/macros/latex/contrib/physunits/CHANGELOG.md
@@ -36,4 +36,24 @@
- modify the makefile to include the new distrubution readme and makefile
- give instructions on using makefile for distribution
- Did a little more reformatting in the README.
+## [1.0.3.d] - 2020/01/26
+- there was some issues and mixup with tags in github. This is just a version
+number change to get the github tags to show up in the right order
+## [1.0.3.e] - 2020/01/26
+### Changed
+- add a section on just build instructions into readme
+## [1.0.4] - 2020/03/26
+### Changes
+- kcal appeared to accept a prefix, though it was ignored; remove option for the
+macro
+- Celcius, Fahrenheit, and Rankine had the ^\circ outside of the ensuremath,
+causing problems for text mode. The degree symbol is also typically typeset
+with the unit instead of with the number. Correct both of these issues.
+- correct version number and file date in dtx and pdf documentation
+- Make sure \micro macro is compatable with siunitx
+### Added
+- Add acknowledgements to documentation
+- Add bug reporting section to documentation
+- Add prerequisites section to documentation
+- Give some explanation of differences to siunitx in introduction
diff --git a/macros/latex/contrib/physunits/physunits.dtx b/macros/latex/contrib/physunits/physunits.dtx
index 103f97c0c8..5bb71b3fa6 100644
--- a/macros/latex/contrib/physunits/physunits.dtx
+++ b/macros/latex/contrib/physunits/physunits.dtx
@@ -22,7 +22,7 @@
%<package>\NeedsTeXFormat{LaTeX2e}[1994/06/01]
%<package> \ProvidesPackage{physunits}
%<*package>
- [2020/01/26 v1.0.3 Physical units package]
+ [2020/03/26 v1.0.4 Physical units package]
%</package>
%<package>\ProcessOptions\relax
%<*driver>
@@ -41,7 +41,7 @@
%</driver>
% \fi
%
-% \CheckSum{486}
+% \CheckSum{490}
%
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
@@ -63,10 +63,12 @@
% \changes{v1.0.1}{2020/01/25}{Clean up formatting, fix index}
% \changes{v1.0.2}{2020/01/25}{External changes in makefile}
% \changes{v1.0.3}{2020/01/26}{External changes in makefile}
+% \changes{v1.0.4}{2020/03/26}{Corrected version number and date in
+% documentation}
%
% \GetFileInfo{physunits.dtx}
-% \DeclareRobustCommand{\fileversion}{v1.0}
-% \DeclareRobustCommand{\filedate}{2020/01/26}
+% \DeclareRobustCommand{\fileversion}{v1.0.4}
+% \DeclareRobustCommand{\filedate}{2020/03/26}
%
% \DoNotIndex{\DeclareRobustCommand,\newenvironment,\DeclareRobustCommand,
% \left,\right,\textbf,\mathrm,\ensuremath,\units@separator,\expandafter,\,}
@@ -86,6 +88,33 @@
% physical units that are commonly used in introductory level physics and
% astronomy classes.
%
+% At present, this package provides some similar units to those in siunitx, but
+% is uses slightly different macro names for each. This package also provides
+% a number of non-SI units (e.g. erg, cm, BTU).
+%
+%
+% \section{Prerequisites / Dependencies}
+% \changes{v1.0.4}{2020/03/26}{Added section for dependencies.}
+%
+% \subsection{General}
+% This package requires the \verb|physunits| package.%
+%
+% \subsection{Generating Documentation}
+% The \verb|hyperref| package are required to generate the documentation
+% (this file) for this package.
+%
+% \section{Acknowledgements}
+% \changes{v1.0.4}{2020/03/26}{Added section for acknowledgements.}
+%
+% The author would like to thank Brian Dunn for catching bugs in the temperature
+% units and kcal, leading to changes in v1.0.4.
+%
+% \section{Bug Reporting}
+% \changes{v1.0.4}{2020/03/26}{Added section for bug reporting.}
+%
+% Please report bugs or issues in this package using github, at
+% \url{https://github.com/astrobit/physunits/issues}.%
+%
% \section{Naming Convention}
%
% most macros consist of just the commonly used letter or unit, e.g.
@@ -613,13 +642,17 @@
%\iffalse
%<*package>
%\fi
-% \begin{macro}{\units@separator}
-% |\units@separator| is a special macro used to set the spacing between a
-% quantity and the associated units.
+% \begin{macro}{\micro}
+% \changes{v1.0.4}{2020/03/26}{Corrected version number and date in
+% documentation}
+% |\micro| is a special macro used to typeset the symbol \textbackslash mu.
+% It is compatable with the \textbackslash micro in siunitx.
%
% \begin{macrocode}
+\ifx\micro\undefined
\DeclareRobustCommand{\micro}{\ensuremath{%
\mu}}
+\fi
% \end{macrocode}
% \end{macro}
%\iffalse
@@ -899,10 +932,12 @@
%<*package>
%\fi
% \begin{macro}{\kcal}
+% \changes{v1.0.4}{2020/03/26}{kcal appeared to take a prefix, but the prefix
+% was ignored; removed the prefix.}
% |\kcal| is a macro for kilo-calories (kcal).
%
% \begin{macrocode}
-\DeclareRobustCommand{\kcal}[1]{\ensuremath{%
+\DeclareRobustCommand{\kcal}{\ensuremath{%
\expandafter\units@separator\mathrm{kcal}}}
% \end{macrocode}
% \end{macro}
@@ -1628,11 +1663,15 @@
%<*package>
%\fi
% \begin{macro}{\Celcius}
+% \changes{v1.0.4}{2020/03/26}{had ${}^\circ$ outside of
+% ensuremath, causing problems for text mode. It is also more common to typeset
+% the $^\circ$ with the unit instead of the number. Corrects both of these
+% issues}
% |\Celcius| is a macro for degrees Celcius $(\Celcius)$.
%
% \begin{macrocode}
-\DeclareRobustCommand{\Celcius}{^\circ\ensuremath{%
-\expandafter\units@separator\mathrm{C}}}
+\DeclareRobustCommand{\Celcius}{\ensuremath{\expandafter\units@separator{}%
+^\circ\mathrm{C}}}
% \end{macrocode}
% \end{macro}
%\iffalse
@@ -1643,11 +1682,15 @@
%<*package>
%\fi
% \begin{macro}{\Rankine}
+% \changes{v1.0.4}{2020/03/26}{had ${}^\circ$ outside of
+% ensuremath, causing problems for text mode. It is also more common to typeset
+% the $^\circ$ with the unit instead of the number. Corrects both of these
+% issues}
% |\Rankine| is a macro for degrees Rankine $(\Rankine)$.
%
% \begin{macrocode}
-\DeclareRobustCommand{\Rankine}{^\circ\ensuremath{%
-\expandafter\units@separator\mathrm{R}}}
+\DeclareRobustCommand{\Rankine}{\ensuremath{%
+\expandafter\units@separator{}^\circ\mathrm{R}}}
% \end{macrocode}
% \end{macro}
%\iffalse
@@ -1658,11 +1701,15 @@
%<*package>
%\fi
% \begin{macro}{\Fahrenheit}
+% \changes{v1.0.4}{2020/03/26}{had ${}^\circ$ outside of
+% ensuremath, causing problems for text mode. It is also more common to typeset
+% the $^\circ$ with the unit instead of the number. Corrects both of these
+% issues}
% |\Fahrenheit| is a macro for degrees Fahrenheit $(\Fahrenheit)$.
%
% \begin{macrocode}
-\DeclareRobustCommand{\Fahrenheit}{^\circ\ensuremath{%
-\expandafter\units@separator\mathrm{F}}}
+\DeclareRobustCommand{\Fahrenheit}{\ensuremath{%
+\expandafter\units@separator{}^\circ\mathrm{F}}}
% \end{macrocode}
% \end{macro}
%\iffalse
diff --git a/macros/latex/contrib/physunits/physunits.pdf b/macros/latex/contrib/physunits/physunits.pdf
index 090dfa7d83..e6f2ad825a 100644
--- a/macros/latex/contrib/physunits/physunits.pdf
+++ b/macros/latex/contrib/physunits/physunits.pdf
Binary files differ