diff --git a/.serena/memories/repl.md b/.serena/memories/repl.md index b7a6683e..9be43b9e 100644 --- a/.serena/memories/repl.md +++ b/.serena/memories/repl.md @@ -5,6 +5,9 @@ whose attributes are facades (`s.lsp`, `s.edit`, `s.fs`, `s.mem`, `s.shell`, `s. Code runs like a notebook cell (module-level exec in the session namespace); the value of a trailing expression is the result. No `return` (a top-level `return` yields a SyntaxError with a hint). +IMPORTANT: The REPL interface is a BETA feature. If you encounter any issues, please report them +but do not submit PRs for it (except for trivial fixes); the implementation is still evolving. + ## Structure - `repl/api/*_api.py`: `FacadeApi` implementations = the single implementation of each operation. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8dad30a6..d9df20eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,7 @@ The following types of contributions can be submitted directly via pull requests For other changes, please open an issue first to discuss your ideas with the maintainers. Do not submit pull requests for beta features (unless they are trivial bug fixes); instead, provide feedback via issues or discussions. +At present, the Serena REPL is a beta feature. ## Licensing and Contributor License Agreement (CLA) diff --git a/docs/autogen_docs.py b/docs/autogen_docs.py index be8bc3ff..20b03e39 100644 --- a/docs/autogen_docs.py +++ b/docs/autogen_docs.py @@ -162,6 +162,8 @@ def autogen_tool_list(target_filename = "01-about/035_tools.md"): "While both interfaces offer the same general functionality for the most part, " "the REPL interface addresses several limitations inherent in the tool-based approach (see [advantages](repl-advantages) below).\n\n" ) + f.write("\n\n:::{note}\nThe Serena REPL is an unreleased BETA feature. Please provide feedback; if you encounter issues, report them.\n:::\n\n") + def tools_section(): f.write("## Tools (Classic Interface)\n\n") diff --git a/src/serena/resources/serena_config.template.yml b/src/serena/resources/serena_config.template.yml index 29485b3e..9f8c9580 100644 --- a/src/serena/resources/serena_config.template.yml +++ b/src/serena/resources/serena_config.template.yml @@ -16,6 +16,7 @@ language_backend: LSP # inclusion/exclusion settings do not apply; instead, the operations available in the REPL are configured # via the API inclusion/exclusion settings (excluded_apis etc.). # The interface is fixed at startup; it can be overridden by the project activated at startup. +# IMPORTANT: The REPL interface is a BETA feature. Please provide feedback; if you encounter issues, report them. agent_interface: tools # line ending convention to use when writing source files.