Skip to content

Commit 0424120

Browse files
committed
Rollback doc changes introduced in b70c49
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
1 parent e8f3d3e commit 0424120

File tree

7 files changed

+123
-123
lines changed

7 files changed

+123
-123
lines changed

CLAUDE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,6 @@ Keep documentation for public interfaces current but reasonably sized. The codeb
131131
Keep documentation concise and focused. Don't write "comprehensive" documentation - aim for reasonable size that covers the essentials without being verbose.
132132

133133
**Documentation Formatting**:
134-
- Due to [Zig issue #20202](https://github.com/ziglang/zig/issues/20202), use `---` as a separator in doc comments instead of other markdown horizontal rules to ensure docs are valid markdown when generated.
135134
- Avoid empty lines in doc comments (lines with only `///`) as they will be skipped during documentation generation.
136135

137136
### Memory Management

src/alloc.zig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const std = @import("std");
88
const Allocator = std.mem.Allocator;
99

1010
/// Lua allocator function that wraps a Zig allocator.
11-
/// ---
11+
///
1212
/// # Arguments
1313
/// - `ptr` - a pointer to the block being allocated/reallocated/freed.
1414
/// - `osize` - the original size of the block or some code about what is being allocated

src/compile.zig

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,29 @@ pub const Compiler = struct {
2828
/// Compilation options for controlling Luau compiler behavior.
2929
pub const Opts = struct {
3030
/// Optimization level.
31-
/// ---
31+
///
3232
/// - `0` - no optimization
3333
/// - `1` - baseline optimization level that doesn't prevent debuggability
3434
/// - `2` - includes optimizations that harm debuggability such as inlining
3535
opt_level: u8 = 1,
3636

3737
/// Debug level.
38-
/// ---
38+
///
3939
/// - `0` - no debugging support
4040
/// - `1` - line info & function names only; sufficient for backtraces
4141
/// - `2` - full debug info with local & upvalue names; necessary for debugger
4242
dbg_level: u8 = 1,
4343

4444
/// Type information level for native code generation.
45+
///
4546
/// Information includes testable types for function arguments, locals, upvalues and some temporaries.
46-
/// ---
47+
///
4748
/// - `0` - generate for native modules
4849
/// - `1` - generate for all modules
4950
type_info_level: u8 = 0,
5051

5152
/// Coverage support level.
52-
/// ---
53+
///
5354
/// - `0` - no code coverage support
5455
/// - `1` - statement coverage
5556
/// - `2` - statement and expression coverage (verbose)

0 commit comments

Comments
 (0)