Add back stub header comment

Author: lagru

examples/example_pkg-stubs/__init__.pyi

@@ -1,4 +1,4 @@
-# Generated with docstub. Manual edits will be overwritten!
+# File generated with docstub
 
 import _numpy as np_
 from _basic import func_contains

examples/example_pkg-stubs/_basic.pyi

@@ -1,4 +1,5 @@
-# Generated with docstub. Manual edits will be overwritten!
+# File generated with docstub
+
 import configparser
 import logging
 from collections.abc import Sequence

examples/example_pkg-stubs/_numpy.pyi

@@ -1,4 +1,5 @@
-# Generated with docstub. Manual edits will be overwritten!
+# File generated with docstub
+
 import numpy as np
 from numpy.typing import ArrayLike, NDArray
 

src/docstub/_cli.py

@@ -25,6 +25,9 @@
 logger = logging.getLogger(__name__)
 
 
+STUB_HEADER_COMMENT = "# File generated with docstub"
+
+
 def _load_configuration(config_path=None):
     """Load and merge configuration from CWD and optional files.
 
@@ -184,6 +187,7 @@ def main(source_dir, out_dir, config_path, verbose):
                 stub_content = stub_transformer.python_to_stub(
                     py_content, module_path=source_path
                 )
+                stub_content = f"{STUB_HEADER_COMMENT}\n\n{stub_content}"
                 stub_content = try_format_stub(stub_content)
             except (SystemExit, KeyboardInterrupt):
                 raise