Skip to content

Commit 7a29824

Browse files
authored
docs: Rename 'Call back into Wolfram from Rust' to 'Evaluate Wolfram code from Rust' (#39)
I changed my mind. The phrase 'call back' is a bit more technical and less likely to be familiar than simply 'evaluate', which is a clearer statement of what's happening. Additionally, a 'callback function' (i.e. a function pointer / closure) is one mechanism for executing code across a library / language boundary, but that is not at all the mechanism used for Rust -> Wolfram evaluations. The new name avoids this potentially misleading connotation.
1 parent 2e52b2c commit 7a29824

File tree

6 files changed

+10
-8
lines changed

6 files changed

+10
-8
lines changed

wolfram-library-link/examples/docs/main.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ mod convert {
33
mod using_expr;
44
}
55

6-
mod call_back_into_wolfram_from_rust {
6+
mod evaluate_wolfram_code_from_rust {
77
mod generate_message;
88
}

wolfram-library-link/src/docs.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
//! ### How Tos
44
//!
55
//! * [How To: Convert Between Rust and Wolfram Types][converting_between_rust_and_wolfram_types]
6-
//! * [How To: Call back into Wolfram from Rust][call_back_into_wolfram_from_rust]
6+
//! * [How To: Evaluate Wolfram code from Rust][evaluate_wolfram_code_from_rust]
77
88
#![allow(unused_imports)]
99

10-
pub mod call_back_into_wolfram_from_rust;
1110
pub mod converting_between_rust_and_wolfram_types;
11+
pub mod evaluate_wolfram_code_from_rust;

wolfram-library-link/src/docs/call_back_into_wolfram_from_rust.rs renamed to wolfram-library-link/src/docs/evaluate_wolfram_code_from_rust.rs

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
/*!
2-
# How To: Call back into Wolfram from Rust
2+
# How To: Evaluate Wolfram code from Rust
33
44
55
## Generating Wolfram messages from Rust
66
7-
Suppose you want to generate a Wolfram [Message\[..\]][ref/Message] from within Rust.
7+
Suppose you want to generate a Wolfram [`Message[..]`][ref/Message] from within Rust.
88
99
The easiest way to accomplish this is to construct an appropriate Wolfram expression
1010
using the [`Expr`] type, and then use the [`evaluate()`] function to call back into
1111
Wolfram to evaluate that expression.
1212
13+
[ref/Message]: https://reference.wolfram.com/language/ref/Message.html
14+
1315
**Rust**
1416
1517
```rust
1618
# mod scope {
1719
*/
18-
#![doc = include_str!("../../examples/docs/call_back_into_wolfram_from_rust/generate_message.rs")]
20+
#![doc = include_str!("../../examples/docs/evaluate_wolfram_code_from_rust/generate_message.rs")]
1921
/*!
2022
# }
2123
```
@@ -24,7 +26,7 @@ Wolfram to evaluate that expression.
2426
2527
```wolfram
2628
*/
27-
#![doc = include_str!("../../RustLink/Examples/Docs/CallBackIntoWolframFromRust/GenerateMessage.wlt")]
29+
#![doc = include_str!("../../RustLink/Examples/Docs/EvaluateWolframCodeFromRust/GenerateMessage.wlt")]
2830
/*!
2931
```
3032

wolfram-library-link/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@
126126
//! # Documentation
127127
//!
128128
//! * [How To: Convert Between Rust and Wolfram Types][crate::docs::converting_between_rust_and_wolfram_types]
129-
//! * [How To: Call back into Wolfram from Rust][docs::call_back_into_wolfram_from_rust]
129+
//! * [How To: Evaluate Wolfram code from Rust][docs::evaluate_wolfram_code_from_rust]
130130
//!
131131
//! *See the [`docs`] module for a complete list of available long-form documentation.*
132132
//!

0 commit comments

Comments
 (0)