Skip to content

Commit 0308aee

Browse files
docs(codegen): drop the meta-commentary about the removed rationale
1 parent f571c7f commit 0308aee

2 files changed

Lines changed: 4 additions & 18 deletions

File tree

src/lib/LibCodeGen.sol

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,10 @@ string constant NEWLINE_DUE_TO_MAX_LENGTH = "\n ";
2323
/// as strings that can be concatenated into complete Solidity files and written
2424
/// to disk by the caller.
2525
library LibCodeGen {
26-
/// The file prefix for autogenerated files: the license, the pragma, and a
27-
/// note that the file is generated and must not be hand-edited. The pragma
28-
/// is `^` as the generated code is expected to be imported into some
29-
/// concrete contract with `pragma =` version.
30-
///
31-
/// Deliberately says nothing about WHY the file is committed. Generated
32-
/// files are committed; that is a fact about the repo, not something each
33-
/// file needs to argue, and the circular-dependency explanation this used
34-
/// to carry is true of a pointers file and false of the other generated
35-
/// files repos write — an alias lib is committed because it IS the source
36-
/// consumers import. Saying nothing is true of all of them, which is what
37-
/// makes this prefix usable by every writer with nothing to parameterise.
26+
/// The file prefix for autogenerated files outlines the license, pragma,
27+
/// and a note about the file being autogenerated. The pragma is ^ as the
28+
/// generated code is expected to be imported into some concrete contract
29+
/// with pragma = version.
3830
function filePrefix() internal pure returns (string memory) {
3931
//REUSE-IgnoreStart
4032
return string.concat(

test/lib/LibCodeGen.filePrefix.t.sol

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,6 @@ contract LibCodeGenFilePrefixTest is Test {
2020
/// change here rewrites committed files org wide. Pinned exactly so that
2121
/// lands as a deliberate, reviewable diff rather than a surprise on the
2222
/// next regeneration.
23-
///
24-
/// It says nothing about why the file is committed. Generated files are
25-
/// committed; that is a fact about the repo rather than something each file
26-
/// argues, and the circular-dependency explanation this used to carry was
27-
/// true of a pointers file and false of an alias lib, which is committed
28-
/// because it IS the source consumers import.
2923
function testFilePrefixExact() external pure {
3024
//REUSE-IgnoreStart
3125
assertEq(

0 commit comments

Comments
 (0)