How to check for insensitive language

The documentation is checked for insensitive or inconsiderate language using alex.

How to install alex

To install alex run:

$ npm install alex --global

Note that this required node, information on install node is available here: https://www.npmjs.com/get-npm

How to run alex

To run alex on the documentation:

$ alex docs**/*.rst

To run alex on the README.md file:

$ alex README.md

How to ignore some checks

To ignore some specific checks annotations can be used. For example John Nash is annotated to ignore insensitive related to gendered pronouns:

.. <!--alex disable he-she-->
.. <!--alex disable her-him-->

This library is named after the mathematician John Nash. He is most famous for
his work in Game Theory that culminated in him winning a Noble prize in
Economics. The book [Nasar2011]_ (popularized in a 2001 movie) gives a good
overview of his life.

The work he received a Noble prize for was a proof that a game **always** has
an equilibrium [Nash1950]_. His proof is an exceptional piece of mathematics
where he uses a fixed point theorem by showing that an equilibrium is equivalent
to a fixed point of a function.

..  <!--alex enable he-she-->
..  <!--alex enable her-him-->

Another example is the README.md file where an annotation is added to ignore a specific use of the word “bi”:

## Usage

Create bi-matrix games by passing two 2 dimensional arrays/lists: