Conversation
The READMEs and the Sphinx pages still described the editor as it was several releases ago, and a few statements had become wrong rather than merely incomplete. - Document folding, bookmarks, multiple carets, snippets, the minimap, split view, the outline, language server support, the test panel, lint diagnostics and the shortcut settings, in English and both Chinese READMEs and in the Eng/Zh editor pages. - Document the gutter change markers, per-change staging, unstage, commit-index, stash and conflict resolution on the Git pages. - Document breakpoints and stepping, the problems and test panels, and the Text menu transforms. - Replace the keyboard shortcut pages with the full list, and separate the keys the editing area handles itself, which cannot be reassigned. - Correct the settings keys in the configuration pages: they named fields that do not exist. List the colour keys the editor actually reads, and the panels the dock menu actually offers. - Correct the language section: four languages, taken from the system locale on a first run, switched without a restart. - Correct the API reference: language_wrapper is an object, not a function. - Correct ai_config.json: it is read, never written, so say to write it yourself and keep it out of version control. - Escape the bold markers before full-width parentheses so the Chinese pages render as intended; the docs now build without warnings.
|
Up to standards ✅🟢 Issues
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The READMEs and the Sphinx pages still described the editor as it was several releases ago, and a few statements had become wrong rather than merely incomplete.
Features that were missing
Ctrl+F9,Ctrl+F5,F10/F11/Shift+F11).Covered in
README.md, both Chinese READMEs, and the Eng/Zh pages for the editor, Git, execution and code quality.Statements that were wrong
README.mdCtrl+Alt+Down/UpF7/Shift+F7configuration.rstui_font_family,editor_font_size,theme,last_open_file,max_output_linesui_font,font_size,ui_style,last_file,max_line_of_outputconfiguration.rstapi_reference.rstlanguage_wrapper("key")is a function.language_word_dict.get(...)ai_assistant.rstai_config.json, and the key can come from the environmentgetting_started.rstkeyboard_shortcuts.rstThat last one is a real gap the documentation was hiding:
Ctrl+D,Ctrl+/,Alt+Up/Alt+Down,Ctrl+B,Ctrl+Shift+\andCtrl++/Ctrl+-are handled in_handle_ctrl_shortcuts/_handle_alt_shortcutsrather than through the shortcut registry, so the settings dialog cannot reach them. The shortcut pages now list them separately as fixed keys.Also
sphinx -b htmlnow completes with no content warnings.