docstr 0.4.7

Ergonomic multi-line string literals
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

[Unreleased]: https://github.com/nik-rev/docstr/compare/v0.4.7...HEAD

## [v0.4.7] - 2025-10-13

[v0.4.7]: https://github.com/nik-rev/docstr/compare/v0.4.6...v0.4.7

- Documentation improvements
 
## [v0.4.6] - 2025-10-13

[v0.4.6]: https://github.com/nik-rev/docstr/compare/v0.4.5...v0.4.6

## [v0.4.5] - 2025-10-13

[v0.4.5]: https://github.com/nik-rev/docstr/compare/v0.4.4...v0.4.5

## [v0.4.4] - 2025-09-21

[v0.4.4]: https://github.com/nik-rev/docstr/compare/v0.4.3...v0.4.4

## [v0.4.3] - 2025-09-21

[v0.4.3]: https://github.com/nik-rev/docstr/compare/v0.4.2...v0.4.3

## [v0.4.2] - 2025-09-19

[v0.4.2]: https://github.com/nik-rev/docstr/compare/v0.4.1...v0.4.2

## [v0.4.1] - 2025-09-19

[v0.4.1]: https://github.com/nik-rev/docstr/compare/v0.4.0...v0.4.1

### Changed

The comma between the last argument before the first doc comment, and the doc comment itself is now optional

```rs
docstr!(write! w,
      //        ^ this comma was required, but now it is optional
  /// Hello, world!
);
```

## [v0.4.0] - 2025-09-19

[v0.4.0]: https://github.com/nik-rev/docstr/compare/v0.3.0...v0.4.0

This release includes more improvement to the error messages, plus a few syntactic changes to make the macro more readable.

### Changed

- The passed macro path must always be followed by a `!`

  ```rs
  docstr!(println!
        //       ^ exclamation mark is required now
    /// Hello, world!
  );
  ```

- The comma between the last argument before the first doc comment, and the doc comment itself is now required

  ```rs
  docstr!(write! w,
        //        ^ this comma was previously optional,
        //          but now it is required
    /// Hello, world!
  );
  ```

- The comma between passed macro path and the first argument is no longer accepted

  ```rs
  docstr!(write! w,
        //      ^ we would previously expect a comma here, but it is
        //        no longer accepted as the `!` is a better indicator
    /// Hello, world!
  );
  ```

## [v0.3.0] - 2025-09-19

[v0.3.0]: https://github.com/nik-rev/docstr/compare/v0.2.0...v0.3.0

## Changed

- Improved error messages

## Removed

- A few invalid cases which were previously accepted are now compile errors

## [v0.2.0] - 2025-09-19

[v0.2.0]: https://github.com/nik-rev/docstr/compare/v0.1.1...v0.2.0

### Changed

- Require at least 1 doc comment inside of `docstr!`

## [v0.1.1] - 2025-09-19

[v0.1.1]: https://github.com/nik-rev/docstr/compare/v0.1.0...v0.1.1