Merge fa6680ff76 into ea85c1b46e

Merge pull request #2142 from cenviity/push-qoxkvmtkyvmv
threads1: Fix typos in description
2024-12-26 00:00:03 +03:00 · 2024-10-22 18:46:33 +06:00 · 2024-10-22 12:35:25 +02:00 · 2024-10-22 16:53:23 +11:00 · 2024-10-16 11:09:09 -05:00 · 2024-10-16 11:07:42 -05:00
3 changed files with 16 additions and 4 deletions
--- a/README.md
+++ b/README.md
@ -45,6 +45,18 @@ cargo install rustlings

 </details>

+> [!CAUTION]
+> Don't try to clone the repository to do the exercises! `rust-analyzer` won't work in that case. Please follow the instructions above instead.
+> 
+> <details>
+> <summary>Why?</summary>
+>
+>The intended way to run Rustlings is to install the binary and run `rustlings init` as described in the installation/initialization sections. This generates a `Cargo.toml` (different than what you see in the repository) that includes each exercise as a separate binary target which is enough for `rust-analyzer` to work.
+>
+>If you just clone the repository and try to run and edit the exercises directly, the language server will not work.
+>
+> </details>
+
 ### Initialization

 After installing Rustlings, run the following command to initialize the `rustlings/` directory:
--- a/exercises/20_threads/threads1.rs
+++ b/exercises/20_threads/threads1.rs
@ -1,5 +1,5 @@
-// This program spawns multiple threads that each run for at least 250ms, and
-// each thread returns how much time they took to complete. The program should
+// This program spawns multiple threads that each runs for at least 250ms, and
+// each thread returns how much time it took to complete. The program should
 // wait until all the spawned threads have finished and should collect their
 // return values into a vector.

--- a/solutions/20_threads/threads1.rs
+++ b/solutions/20_threads/threads1.rs
@ -1,5 +1,5 @@
-// This program spawns multiple threads that each run for at least 250ms, and
-// each thread returns how much time they took to complete. The program should
+// This program spawns multiple threads that each runs for at least 250ms, and
+// each thread returns how much time it took to complete. The program should
 // wait until all the spawned threads have finished and should collect their
 // return values into a vector.
Author	SHA1	Message	Date
Eric Eastwood	7aee1ae212	Merge `fa6680ff76` into `ea85c1b46e`	2024-10-22 18:46:33 +06:00
Mo	ea85c1b46e	Merge pull request #2142 from cenviity/push-qoxkvmtkyvmv threads1: Fix typos in description	2024-10-22 12:35:25 +02:00
Vincent Ging Ho Yim	6bec6f92c4	threads1: Fix typos in description	2024-10-22 16:53:23 +11:00
Eric Eastwood	fa6680ff76	Correctly point to sections	2024-10-16 11:09:09 -05:00
Eric Eastwood	2bccdcbd2c	Use simple caution message with expand for more details	2024-10-16 11:07:42 -05:00
Eric Eastwood	60e0d4ae8a	Fix some grammar	2024-10-16 11:01:41 -05:00
Eric Eastwood	a025ce0538	Add warning about `rust-analyzer` not working if you clone and use the repo directly > Yes, you are right, if you just clone the repository and try to edit the exercises, the language server will not work. This is one downside of the current approach. But this only affects developing exercises. > > The new method of doing Rustlings is to install Rustlings using `cargo install rustlings` (not published yet), then running `rustlings init`. No repo cloning happens. Instead, the directory `rustlings/` will be created where you find the exercises. The language server works there out of the box :) > > I need to add a warning when people try to work on the exercises from the repository. Thanks pointing this out. > > -- @mo8it, https://github.com/rust-lang/rustlings/issues/1935#issuecomment-2067664066 Other references: - Previous `rustlings lsp` command: https://github.com/rust-lang/rustlings/pull/1026 - The changelog says "LSP support out of the box", https://github.com/rust-lang/rustlings/blob/main/CHANGELOG.md#lsp-support-out-of-the-box	2024-10-14 14:11:09 -05:00