ITADN

fix (doc): improvements to some words in the documentation

#965Pull RequestNopAngel 创建于 2026-01-08
N
NopAngelcommented
Hey, everyone! Good morning (and Happy New Year, by the way). This is a pull request "fixing" the `doc/catpuccin.txt` file. Here's the list of corrections: ### 1. First point (Vim/Neovim) Before: ``` Supports both Vim and Neovim (requires neovim https://github.com/neovim/neovim/ >= 0.8 or vim https://github.com/vim/vim >= 9 compiled with lua https://github.com/lua/lua >= 5.1) ``` Problems: - "Heavy" structure: It's a very long sentence full of parentheses/links that makes the requirements difficult to read. - Lack of clarity: It's not immediately clear which version corresponds to each editor. Solution: - I converted the sentence into a list with sub-points. This way, the reader instantly sees: "Ah, Neovim needs this, Vim needs that." - I separated the links and placed them right after the name of the software they reference. - I changed >= to "version X or higher," which is just as precise but sounds more natural in English. - I moved the Lua detail (which only applies to Vim) to its corresponding line. ### 2. "flavours" Before: - "4 different flavours" Correction: - "4 pre-made styles" Reason: "Flavours" is understood (it's common in computing for "variants"), but in the context of themes/colors, words like "styles", "variants" or "presets" are more universal and professional. ### 3. "the ability to create your own" Before: - "and the ability to create your own!" Correction: - "and tools to create your own" Reason: "The ability" sounds a bit like technical jargon. It's correct, but not very engaging. "and tools to create your own" is more direct and proactive. It implies that the project already provides you with the tools, not just the "possibility." I removed the exclamation mark (!) to maintain a consistent and professional tone throughout the list. ### 4. "Compiled configuration" Before: - "Compiled configuration for fast startup time" Correction: - "Uses pre-compiled configurations for extremely fast startup times" Reason: "Compiled" por sí solo puede confundirse con "compilado en el momento". "Pre-compiled" deja claro que las configuraciones se procesan antes (pre-) para que al cargar el tema sea instantáneo. Este es el término técnico correcto para esta optimización. "Extremely fast" es más enfático y fiel al entusiasmo del link de Reddit que menciona "1ms". ### 5. "Integrations with lsp, treesitter and a bunch of plugins" Before: - "Integrations with lsp, treesitter and a bunch of plugins" ### 6. "Support for many other applications" Correction: - "Integrates with LSP, Tree-sitter, and many popular plugins" Reason: "Integrates with" is a more dynamic and common way to say it than "Integrations with." "LSP" and "Tree-sitter" should be capitalized or hyphenated, as they are proper names of technologies. "A bunch of" is very informal. "Many popular" maintains the informality but sounds more respectable and better describes the advantage (they're not just any plugins, they're the popular ones, the ones you're likely to use). ### 6. "Support for many other applications" Before: - "Support for many other applications" Correction: - "Also available for numerous other applications" Reason: "Support for" is a bit vague. Technical support? Compatibility? "Also available for" is the standard and clear way to say, "You can also use this same theme/style on...". It perfectly reflects the fact that Catppuccin is a theme ecosystem. "numerous" is an elegant alternative to "many". ## Summary of Main Improvements: Structure: More visually scannable (use of sublists). Accuracy: More precise technical language ("pre-compiled," "LSP"). Tone: Remains approachable but more polished for documentation. Clarity: Each point communicates its benefit more immediately and is easier to understand. Thank you so much for reading this PR, whoever is reading it; have a happy day/afternoon/evening! :p
合并状态:未合并 1 条评论