Skip to content

Commit 55d7d71

Browse files
Merge #8267
8267: Adding gifs and screenshots for features in manual r=matklad a=MozarellaMan For #6539 This includes most of gif or screenshot examples of most items in the "Features" header. With the exceptions of: - **On Typing Assists** - couldn't get it to work for a demo, I'm probably missing something? - **Structural search and replace** - looked to be already a visual example of the feature - **Workspace symbol** - wasn't sure how best to show this, all of the examples maybe? Also wasn't sure of the best code example to show it off - **Semantic Syntax Highlighting** - seemed obvious enough to not need a screenshot, but I could easily add this All the gifs/pngs are hosted in this [comment](#6539 (comment)). Please let me know if any of them aren't suitable (and why) and I'll improve it! Or if you don't like the theme/font Co-authored-by: Ayomide Bamidele <[email protected]>
2 parents c69f6f3 + 2760226 commit 55d7d71

24 files changed

+44
-0
lines changed

crates/ide/src/annotations.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ use crate::{
1919
//
2020
// Provides user with annotations above items for looking up references or impl blocks
2121
// and running/debugging binaries.
22+
//
23+
// image::https://user-images.githubusercontent.com/48062697/113020672-b7c34f00-917a-11eb-8f6e-858735660a0e.png[]
2224
#[derive(Debug)]
2325
pub struct Annotation {
2426
pub range: TextRange,

crates/ide/src/expand_macro.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ pub struct ExpandedMacro {
2323
//
2424
// | VS Code | **Rust Analyzer: Expand macro recursively**
2525
// |===
26+
//
27+
// image::https://user-images.githubusercontent.com/48062697/113020648-b3973180-917a-11eb-84a9-ecb921293dc5.gif[]
2628
pub(crate) fn expand_macro(db: &RootDatabase, position: FilePosition) -> Option<ExpandedMacro> {
2729
let sema = Semantics::new(db);
2830
let file = sema.parse(position.file_id);

crates/ide/src/extend_selection.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ use crate::FileRange;
2424
//
2525
// | VS Code | kbd:[Alt+Shift+→], kbd:[Alt+Shift+←]
2626
// |===
27+
//
28+
// image::https://user-images.githubusercontent.com/48062697/113020651-b42fc800-917a-11eb-8a4f-cf1a07859fac.gif[]
2729
pub(crate) fn extend_selection(db: &RootDatabase, frange: FileRange) -> TextRange {
2830
let sema = Semantics::new(db);
2931
let src = sema.parse(frange.file_id);

crates/ide/src/file_structure.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ pub enum StructureNodeKind {
3535
//
3636
// | VS Code | kbd:[Ctrl+Shift+O]
3737
// |===
38+
//
39+
// image::https://user-images.githubusercontent.com/48062697/113020654-b42fc800-917a-11eb-8388-e7dc4d92b02e.gif[]
40+
3841
pub(crate) fn file_structure(file: &SourceFile) -> Vec<StructureNode> {
3942
let mut res = Vec::new();
4043
let mut stack = Vec::new();

crates/ide/src/goto_definition.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ use crate::{
2121
//
2222
// | VS Code | kbd:[F12]
2323
// |===
24+
//
25+
// image::https://user-images.githubusercontent.com/48062697/113065563-025fbe00-91b1-11eb-83e4-a5a703610b23.gif[]
2426
pub(crate) fn goto_definition(
2527
db: &RootDatabase,
2628
position: FilePosition,

crates/ide/src/goto_implementation.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ use crate::{display::TryToNav, FilePosition, NavigationTarget, RangeInfo};
1616
//
1717
// | VS Code | kbd:[Ctrl+F12]
1818
// |===
19+
//
20+
// image::https://user-images.githubusercontent.com/48062697/113065566-02f85480-91b1-11eb-9288-aaad8abd8841.gif[]
1921
pub(crate) fn goto_implementation(
2022
db: &RootDatabase,
2123
position: FilePosition,

crates/ide/src/goto_type_definition.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ use crate::{display::TryToNav, FilePosition, NavigationTarget, RangeInfo};
1212
//
1313
// | VS Code | **Go to Type Definition*
1414
// |===
15+
//
16+
// image::https://user-images.githubusercontent.com/48062697/113020657-b560f500-917a-11eb-9007-0f809733a338.gif[]
1517
pub(crate) fn goto_type_definition(
1618
db: &RootDatabase,
1719
position: FilePosition,

crates/ide/src/hover.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ pub struct HoverResult {
8282
//
8383
// Shows additional information, like type of an expression or documentation for definition when "focusing" code.
8484
// Focusing is usually hovering with a mouse, but can also be triggered with a shortcut.
85+
//
86+
// image::https://user-images.githubusercontent.com/48062697/113020658-b5f98b80-917a-11eb-9f88-3dbc27320c95.gif[]
8587
pub(crate) fn hover(
8688
db: &RootDatabase,
8789
position: FilePosition,

crates/ide/src/inlay_hints.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ pub struct InlayHint {
5252
//
5353
// | VS Code | **Rust Analyzer: Toggle inlay hints*
5454
// |===
55+
//
56+
// image::https://user-images.githubusercontent.com/48062697/113020660-b5f98b80-917a-11eb-8d70-3be3fd558cdd.png[]
5557
pub(crate) fn inlay_hints(
5658
db: &RootDatabase,
5759
file_id: FileId,

crates/ide/src/join_lines.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ use text_edit::{TextEdit, TextEditBuilder};
1919
//
2020
// | VS Code | **Rust Analyzer: Join lines**
2121
// |===
22+
//
23+
// image::https://user-images.githubusercontent.com/48062697/113020661-b6922200-917a-11eb-87c4-b75acc028f11.gif[]
2224
pub(crate) fn join_lines(file: &SourceFile, range: TextRange) -> TextEdit {
2325
let range = if range.is_empty() {
2426
let syntax = file.syntax();

0 commit comments

Comments
 (0)