docs: stop duplicating the language count in the Orbit Local section - #3
rajanpanth wants to merge 1 commit into
Conversation
The Orbit Local blurb carried its own '11+ languages' count alongside the one in the Orbit Remote section below it and the table in docs/source/indexed-data.md. Three copies of the same number drift: the table currently lists 13 languages, the Remote section names 14, and crates/code-graph/src/v2/config/lang.rs declares 20. Pointing at Orbit Remote instead of restating a number keeps the two sections in step without another figure to maintain.
e409f4d to
3c86609
Compare
|
Rebased onto current The original premise was wrong. I opened this to change The PR now drops the duplicated count from the Orbit Local blurb instead, so that sentence defers to the Remote section rather than carrying its own figure. Title and description updated to match. Happy to close this if you would rather leave the wording as is. |
The Orbit Local section restates the supported-language count that already appears twice elsewhere in the project, and the three copies have drifted apart:
README.md, Orbit Local section11+ languagesREADME.md, Orbit Remote section11+ languages, then names 14 of them including Elixirdocs/source/indexed-data.mdtablecrates/code-graph/src/v2/config/lang.rsRather than adding a fourth number to keep in sync, this points the Orbit Local blurb at the Orbit Remote section it is already deferring to:
One line, and nothing left in that sentence to go stale.
Note on the original scope of this PR. It was opened to change the Orbit Local count from
11+to13to match the docs table. That was wrong, and I would rather say so than quietly reword it:mainhas since grown Elixir support (crates/code-graph/src/v2/langs/generic/elixir.rs, registered inconfig/lang.rs), so writing13there would have asserted a number that is too low and the diff would have dropped Elixir from the list in the Remote section. The docs table is the stale artefact, not the README. I have not touched the table here, since deciding which of the 20 declared languages belong in a table whose columns are "Definitions" and "Cross-file references" is a call for someone who knows which are full parsers and which are the generic DSL path.