Don't make assumptions about gender in your documentation.
If you use VIM, you can use the following configuration to alert you to any gender-specific pronouns in your documentation, giving you the chance to de-gender them as necessary.
gender.vim
extends the syntax highlighting of a filetype to highlight certain words.
You will need to load this after any default syntax highlighting gets applied to your filetype. The after
directory in VIM gets loaded after other plugins or syntax files, making it the location where you should store extensions to existing behavior. If doesn't exist already, make a ~/.vim/after/syntaxdirectory, and place
gender.vim` inside it.
By default, files in the syntax
directory are loaded by the filetype of the file you're editing. ~/.vim/after/syntax/html.vim
would be loaded when editing an HTML file, for example, letting you declare language-specific syntax.
You can make it apply to multiple filetypes by adding the following to your ~/.vimrc
file, or another location that gets autoloaded by your vim editor.
au BufNewFile,BufRead *.md,*.html so ~/.vim/after/syntax/gender.vim
This command runs by default on files whose extension match *.md,*.html
, i.e. Markdown and HTML files. You can add addition comma-separated file extensions to make this run on additional filetypes. Or, include the following to make it run on all filetypes:
au BufNewFile,BufRead * so ~/.vim/after/syntax/gender.vim