Skip to content

Commit ab10559

Browse files
committed
cust: remove trailing colons from doc headings.
They're non-standard and unnecessary.
1 parent f667f03 commit ab10559

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

crates/cust/src/error.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! Types for error handling
22
//!
3-
//! # Error handling in CUDA:
3+
//! # Error handling in CUDA
44
//!
55
//! cust uses the [`CudaError`](enum.CudaError.html) enum to represent the errors returned by
66
//! the CUDA API. It is important to note that nearly every function in CUDA (and therefore

crates/cust/src/function.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ impl Function<'_> {
474474

475475
/// Launch a kernel function asynchronously.
476476
///
477-
/// # Syntax:
477+
/// # Syntax
478478
///
479479
/// The format of this macro is designed to resemble the triple-chevron syntax used to launch
480480
/// kernels in CUDA C. There are two forms available:

crates/cust/src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@
66
//! provides unsafe functions for retrieving and setting handles to raw CUDA objects.
77
//! This allows advanced users to embed libraries that rely on CUDA, such as OptiX.
88
//!
9-
//! # CUDA Terminology:
9+
//! # CUDA Terminology
1010
//!
11-
//! ## Devices and Hosts:
11+
//! ## Devices and Hosts
1212
//!
1313
//! This crate and its documentation uses the terms "device" and "host" frequently, so it's worth
1414
//! explaining them in more detail. A device refers to a CUDA-capable GPU or similar device and its
1515
//! associated external memory space. The host is the CPU and its associated memory space. Data
1616
//! must be transferred from host memory to device memory before the device can use it for
1717
//! computations, and the results must then be transferred back to host memory.
1818
//!
19-
//! ## Contexts, Modules, Streams and Functions:
19+
//! ## Contexts, Modules, Streams and Functions
2020
//!
2121
//! A CUDA context is akin to a process on the host - it contains all of the state for working with
2222
//! a device, all memory allocations, etc. Each context is associated with a single device.
@@ -30,7 +30,7 @@
3030
//! stream. Work within a single stream will execute sequentially in the order that it was
3131
//! submitted, and may interleave with work from other streams.
3232
//!
33-
//! ## Grids, Blocks and Threads:
33+
//! ## Grids, Blocks and Threads
3434
//!
3535
//! CUDA devices typically execute kernel functions on many threads in parallel. These threads can
3636
//! be grouped into thread blocks, which share an area of fast hardware memory known as shared
@@ -44,7 +44,7 @@
4444
//! hand, if the thread blocks are too small each processor will be under-utilized and the
4545
//! code will be unable to make effective use of shared memory.
4646
//!
47-
//! # Usage:
47+
//! # Usage
4848
//!
4949
//! Before using cust, you must install the CUDA development libraries for your system. Version
5050
//! 9.0 or newer is required. You must also have a CUDA-capable GPU installed with the appropriate

crates/cust/src/memory/pointer.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ impl<T: DeviceCopy> UnifiedPointer<T> {
429429

430430
/// Returns a null unified pointer.
431431
///
432-
/// # Examples:
432+
/// # Examples
433433
///
434434
/// ```
435435
/// # let _context = cust::quick_init().unwrap();

crates/cust/src/module.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ impl Module {
338338

339339
/// Get a reference to a global symbol, which can then be copied to/from.
340340
///
341-
/// # Panics:
341+
/// # Panics
342342
///
343343
/// This function panics if the size of the symbol is not the same as the `mem::sizeof<T>()`.
344344
///

0 commit comments

Comments
 (0)