[I] [Bug] Two Python snippets in the docs call APIs that don't exist [flink-agents]

["weiqingy (via GitHub)" <gi...@apache.org>]

weiqingy opened a new issue, #973:
URL: https://github.com/apache/flink-agents/issues/973

   ### Search before asking
   
   - [X] I searched in the [issues](https://github.com/apache/flink-agents/issues) and found nothing similar.
   
   ### Description
   
   Two Python samples on the doc site call APIs that do not exist, so a reader who copies either one gets an immediate failure. In both cases other pages already spell the same thing correctly, which suggests drift rather than a deliberate convention.
   
   **1. `get_configuration()` is not a method.**
   
   `docs/content/docs/operations/configuration.md:51` writes:
   
   ```python
   config = agents_env.get_configuration()
   ```
   
   The method is `get_config`, declared at `python/flink_agents/api/execution_environment.py:163`. `grep -rn "get_configuration" python/` returns nothing at all. Five other doc locations already use `get_config` correctly, for example `docs/content/docs/development/memory/long_term_memory.md:67`, and the Java snippet further down the same page is correct.
   
   **2. The `Agent` import in the tool-use guide raises `ImportError`.**
   
   `docs/content/docs/development/tool_use.md:192` writes:
   
   ```python
   from flink_agents.api.agents import Agent
   ```
   
   `python/flink_agents/api/agents/__init__.py` contains only the license header, so `Agent` is not re-exported there. `docs/content/docs/development/skills.md:94` uses the path that works:
   
   ```python
   from flink_agents.api.agents.agent import Agent
   ```
   
   Neither affects runtime behavior, but both are copy-paste surfaces, so the cost lands entirely on new users following the guides.
   
   Worth noting for context: nothing in pull request CI reads these files. `ci.yml` has no `paths:` filter so every job runs on a docs change, but none of them read `docs/content`, and the site build in `docs.yml` runs on a nightly schedule rather than on pull requests. So a broken sample stays green through review.
   
   Scoped to these two on purpose. Two other documentation issues I noticed while checking these are being filed separately, since one is a prose rewrite with more than one defensible correction and the other needs a decision about intended sidebar ordering.
   
   ### How to reproduce
   
   For the first, search the source for the name the doc uses:
   
   ```
   grep -rn "get_configuration" python/
   grep -rn "def get_config" python/flink_agents/api/execution_environment.py
   ```
   
   The first returns nothing; the second returns the real method.
   
   For the second, run the import against the repo's `python/` directory:
   
   ```
   python -c "from flink_agents.api.agents import Agent"
   ```
   
   This raises `ImportError: cannot import name 'Agent' from 'flink_agents.api.agents'`. Substituting `from flink_agents.api.agents.agent import Agent` succeeds and resolves to `<class 'flink_agents.api.agents.agent.Agent'>`.
   
   ### Version and environment
   
   `main` at `99ab9e4e`. Both are documentation-only and independent of Flink version, deployment mode, Java/Python environment, or OS architecture.
   
   ### Are you willing to submit a PR?
   
   - [X] I'm willing to submit a PR!
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] [Bug] Two docs snippets call APIs that don't exist, and a schema parity claim is wrong [flink-agents]

["wenjin272 (via GitHub)" <gi...@apache.org>]

wenjin272 closed issue #973: [Bug] Two docs snippets call APIs that don't exist, and a schema parity claim is wrong
URL: https://github.com/apache/flink-agents/issues/973


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org