docs: update environment variable name for request timeout to OFREP_TIMEOUT_MS#60
Conversation
…IMEOUT_MS Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Summary of ChangesHello @askpt, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the clarity and accuracy of the project's documentation. It specifically updates the name of an environment variable used for configuring request timeouts, ensuring that users and developers refer to the correct and more descriptive variable name. This change helps maintain consistency across the system and improves the overall developer experience by providing precise configuration instructions. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request updates the environment variable for request timeout from OFREP_TIMEOUT to OFREP_TIMEOUT_MS in the SDK configuration ADR. This is an excellent change, as appending _MS to the variable name makes the unit (milliseconds) explicit, which improves clarity and reduces the risk of misconfiguration. The change is correctly implemented within the ADR file. The PR is ready for merging.
lukas-reining
left a comment
There was a problem hiding this comment.
Makes sense, as discussed!
|
Looks good! thanks! |
Signed-off-by: André Silva 2493377+askpt@users.noreply.github.com
This PR
Following recommendation from @jonathannorris: #54 (comment)
This pull request makes a small but important change to the SDK configuration environment variables documentation. The environment variable for request timeout has been renamed for clarity and consistency.
OFREP_TIMEOUTtoOFREP_TIMEOUT_MSin0007-sdk-configuration-environment-variables.mdto clarify that the value is in milliseconds.Related Issues
Fixes #53
Notes
Since there is no OFREP provider with this implementation yet, I followed @lukas-reining and @thomaspoignant to just update the document instead of creating a new one.