rename TODO to NOTE

There's nothing immediately actionable for raito here, let's make this a
generic NOTE, so people stumbling into this know to open a bug report.

Author: flokli

crate2nix/Cargo.nix

@@ -2894,8 +2894,9 @@ rec {
           # because we compiled those test binaries in the former and not the latter.
           # So all paths will expect source tree to be there and not in the build top directly.
           # For example: $NIX_BUILD_TOP := /build in general, if you ask yourself.
-          # TODO(raitobezarius): I believe there could be more edge cases if `crate.sourceRoot`
-          # do exist but it's very hard to reason about them, so let's wait until the first bug report.
+          # NOTE: There could be edge cases if `crate.sourceRoot` does exist but
+          # it's very hard to reason about them.
+          # Open a bug if you run into this!
           mkdir -p source/
           cd source/
 

crate2nix/templates/nix/crate2nix/default.nix

@@ -140,8 +140,9 @@ rec {
           # because we compiled those test binaries in the former and not the latter.
           # So all paths will expect source tree to be there and not in the build top directly.
           # For example: $NIX_BUILD_TOP := /build in general, if you ask yourself.
-          # TODO(raitobezarius): I believe there could be more edge cases if `crate.sourceRoot`
-          # do exist but it's very hard to reason about them, so let's wait until the first bug report.
+          # NOTE: There could be edge cases if `crate.sourceRoot` does exist but
+          # it's very hard to reason about them.
+          # Open a bug if you run into this!
           mkdir -p source/
           cd source/
 

sample_projects/bin_with_git_submodule_dep/Cargo.nix

@@ -1488,8 +1488,9 @@ rec {
           # because we compiled those test binaries in the former and not the latter.
           # So all paths will expect source tree to be there and not in the build top directly.
           # For example: $NIX_BUILD_TOP := /build in general, if you ask yourself.
-          # TODO(raitobezarius): I believe there could be more edge cases if `crate.sourceRoot`
-          # do exist but it's very hard to reason about them, so let's wait until the first bug report.
+          # NOTE: There could be edge cases if `crate.sourceRoot` does exist but
+          # it's very hard to reason about them.
+          # Open a bug if you run into this!
           mkdir -p source/
           cd source/
 

sample_projects/codegen/Cargo.nix

@@ -663,8 +663,9 @@ rec {
           # because we compiled those test binaries in the former and not the latter.
           # So all paths will expect source tree to be there and not in the build top directly.
           # For example: $NIX_BUILD_TOP := /build in general, if you ask yourself.
-          # TODO(raitobezarius): I believe there could be more edge cases if `crate.sourceRoot`
-          # do exist but it's very hard to reason about them, so let's wait until the first bug report.
+          # NOTE: There could be edge cases if `crate.sourceRoot` does exist but
+          # it's very hard to reason about them.
+          # Open a bug if you run into this!
           mkdir -p source/
           cd source/
 

sample_projects/sub_dir_crates/Cargo.nix

@@ -272,8 +272,9 @@ rec {
           # because we compiled those test binaries in the former and not the latter.
           # So all paths will expect source tree to be there and not in the build top directly.
           # For example: $NIX_BUILD_TOP := /build in general, if you ask yourself.
-          # TODO(raitobezarius): I believe there could be more edge cases if `crate.sourceRoot`
-          # do exist but it's very hard to reason about them, so let's wait until the first bug report.
+          # NOTE: There could be edge cases if `crate.sourceRoot` does exist but
+          # it's very hard to reason about them.
+          # Open a bug if you run into this!
           mkdir -p source/
           cd source/