Formatting docs - backticks and lowercase for 'conda-forge'
This PR aims at fixing #1370
This PR tries to fix the inconsistency across docs by changing mentions of Conda-forge or Conda-Forge to conda-forge (Double backticks)
PR Checklist:
- [X] make all edits to the docs in the
srcdirectory, not indocsor in the html files - [X] note any issues closed by this PR with closing keywords
- [ ] put any other relevant information below
Hi @beckermr and @kathatherine can you please take a look and let me know if I could better the PR?
(Also, thank god for VS Code 😅🤞)
Looks great!
I wonder if at this point we should consider RST substitutions. That way we always use |conda-forge| and standardize in one place how this is rendered. But if this complicates the discussion, we can also leave it aside.
@jaimergp that's okay. If it will help in the long run, I'll change it.
Maybe I can experiment with a few lines first. If it doesn't work out I'll drop the commit.
@jaimergp i find that the substitutions increase indirection and make it really difficult to read the source text.
I would personally prefer adding a linting step to catch poorly formatted words in the RST.
One problem I see with always using conda-forge instead of conda-forge is that in RST is not possible to have monospace words in a hyperlink, which would lead to inconsistencies. As a result I am inclined to say we should just have always lowercased (given the precedent), unless it refers to the conda-forge channel in Anaconda.org. In that case, it should be backticked.