Skip to content

Documentation copy-editing + some fixes - #1461

Merged
prandla merged 4 commits into
cms-dev:mainfrom
e-i-o:doc-updates
Jul 11, 2025
Merged

Documentation copy-editing + some fixes#1461
prandla merged 4 commits into
cms-dev:mainfrom
e-i-o:doc-updates

Conversation

@prandla

@prandla prandla commented Jul 10, 2025

Copy link
Copy Markdown
Member
  • use `` in places where bare ` were used previously (in most cases i think `` was what was intended originally anyways)
  • fix missing references and other sphinx errors
  • change json code-blocks to use comments to indicate the types of things (open to suggestions on how to format this better)
  • updated some docs that referred to unsupported installation methods

todo:

  • i think i saw a dead link on one page.
  • i'd like to use {install_dir} instead of {target} to refer to the installation directory. (i already did it in the places i touched, but should change it everywhere for consistency)

@pxsit

pxsit commented Jul 11, 2025

Copy link
Copy Markdown
Contributor

Task type line 201 distutils link is dead
Replace with https://docs.python.org/3.11/distutils/setupscript.html

@gollux

gollux commented Jul 11, 2025

Copy link
Copy Markdown
Contributor

OK, let's call it installation directory.

@prandla
prandla merged commit bfdc54f into cms-dev:main Jul 11, 2025
1 check passed
@prandla
prandla deleted the doc-updates branch July 11, 2025 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants