Skip to content

Commit

Permalink
Fix a number of small issues.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ken Kundert authored and Ken Kundert committed Aug 18, 2020
1 parent 68e8cc5 commit 88df44a
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 24 deletions.
5 changes: 0 additions & 5 deletions CUSTOMIZING
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@ EC is constructed from four files:
confine any customization to this file.
ec.py:
Provides a command line interface for the calculator.
manpage.py:
Generates the manpage for the calculator. The sections that describe the
details of the available actions are automatically generated from the
information contained in actions.py. However, you may find it necessary
to modify the remaining text descriptions if you make large changes.

calculator.py provides a collection of class definitions that are used implement
the various types of available actions. Those classes include:
Expand Down
13 changes: 1 addition & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@ More information on both ec and ec0 can be found at `NurdleTech
Installing from Source
----------------------

Installation of the manpage is not completely robust when using pip. If it is
not working for you, you should install from source. To get the source code::
To get the source code::

$ git clone https://github.com/KenKundert/ec.git

Expand All @@ -66,16 +65,6 @@ To install::

$ python setup.py install --user

To create and install the manpage, run::

$ ./manpage.py
$ mkdir -p ~/.local/man/man1
$ cp ec.1 ~/.local/man/man1

To read the EC manual::

$ man ec

To run EC::

$ ec
Expand Down
1 change: 0 additions & 1 deletion clean
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#!/usr/bin/env bash

set nonomatch
#rm -f ec.1 ec.1.rst ec.1.pdf
rm -rf generated_settings

# the rest is common to all python directories
Expand Down
2 changes: 1 addition & 1 deletion doc/create-manual.py
Original file line number Diff line number Diff line change
Expand Up @@ -830,7 +830,7 @@ def write(user_filename=None, reference_filename=None):
[user_filename, reference_filename],
):
if filename:
rst = dedent(template[1:-1]).format(
rst = dedent(template).format(
date = __released__,
version = __version__,
integers = dedent(integerSection),
Expand Down
1 change: 1 addition & 0 deletions doc/engineering_calculator
2 changes: 2 additions & 0 deletions doc/reference.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

Operator, Function, Number and Command Reference
================================================

Expand Down Expand Up @@ -1106,3 +1107,4 @@ Miscellaneous Commands
``about``: print information about this calculator



10 changes: 5 additions & 5 deletions doc/user.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

Synopsis
========
**ec** [*options*] [*scripts* ...]
Expand Down Expand Up @@ -181,7 +182,6 @@ remembers them, but they do not survive any operation where the resulting
units would be in doubt. In this way it displays units when it can, but
should never display incorrect or misleading units. For example:


| **0**: 100MHz
| **100 MHz**: 2pi*
| **628.32M**:
Expand Down Expand Up @@ -452,8 +452,8 @@ At start up **ec** reads and executes commands from files. It first tries
'~/.ecrc' and runs any commands it contains if it exists. It then tries
'./.ecrc' if it exists. Finally it runs the startup file specified on the
command line (with the **-s** or **--startup** option). It is common to put
your generic preferences in '~/.exrc'. For example, if your are an astronomer
with a desire for high precision results, you might use:
your generic preferences in '~/.exrc'. For example, if your are an
astronomer with a desire for high precision results, you might use:

| eng6
| 6.626070e-27 "erg-s" =h # Planck's constant in CGS units
Expand Down Expand Up @@ -625,8 +625,8 @@ Alternatively, you can put the constants you wish to predeclare in
in *~/.ecrc* causes them to be declared for every invocation of *ec*.


Diagnostics
===========
Errors
======

If an error occurs on a line, an error message is printed and the stack is
restored to the values it had before the line was entered. So it is almost
Expand Down

0 comments on commit 88df44a

Please sign in to comment.