-
Notifications
You must be signed in to change notification settings - Fork 0
add adocs for sys_context function #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughDocumentation is added across Chinese and English to introduce comprehensive SYS_CONTEXT built-in function support. Navigation structures are restructured to group the function under a new "Built-in Functions" section, and detailed reference pages with implementation details and parameter documentation are created. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CN/modules/ROOT/pages/master/6.4.1.adoc (1)
48-48: Minor: Consider standardizing table column widths across EN and CN versions.The English version uses
[cols="3,7"]for parameter tables while the Chinese version uses[cols="2,8"]. While this difference may be intentional to accommodate text width for translations, standardizing to a consistent column specification across both languages would improve visual consistency. This is a low-priority suggestion if the current widths provide better readability in each language.Also applies to: 63-63
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
CN/modules/ROOT/nav.adoc(1 hunks)CN/modules/ROOT/pages/master/6.4.1.adoc(1 hunks)CN/modules/ROOT/pages/master/7.8.adoc(46 hunks)EN/modules/ROOT/nav.adoc(1 hunks)EN/modules/ROOT/pages/master/6.4.1.adoc(1 hunks)EN/modules/ROOT/pages/master/7.8.adoc(45 hunks)
🔇 Additional comments (6)
EN/modules/ROOT/pages/master/6.4.1.adoc (1)
1-91: Comprehensive and well-structured documentation.The SYS_CONTEXT function documentation effectively covers implementation principles, the function skeleton with proper
SECURITY INVOKERdeclaration, and thorough parameter documentation across both USERENV and SYS_SESSION_ROLES namespaces. The AsciiDoc formatting is correct, and the content provides clear guidance for users.EN/modules/ROOT/nav.adoc (1)
28-30: Navigation restructuring is correct and logically organized.The new "Built-in Functions" grouping (Line 28) with nested
sys_contextreference (Line 29) is properly positioned as a sibling to "Compatibility Features," and the GB18030 entry (Line 30) is appropriately maintained as a sibling group. The hierarchy is syntactically correct and the cross-reference targets the new documentation page.CN/modules/ROOT/nav.adoc (1)
29-31: Chinese navigation restructuring mirrors English version appropriately.The 内置函数 (Built-in Functions) grouping and corresponding sys_context entry are correctly positioned as siblings to 兼容特性 with proper hierarchy. Cross-references are valid and match the documentation files.
CN/modules/ROOT/pages/master/7.8.adoc (1)
77-77: SYS_CONTEXT properly integrated into Chinese public function catalog.The function entry (Line 77) is correctly added to the catalog table, and the documentation block (Lines 1144–1150) includes a clear description and practical example (
sys_context('USERENV','DB_NAME')). The format is consistent with other function entries in the file.Also applies to: 1144-1150
EN/modules/ROOT/pages/master/7.8.adoc (1)
77-77: SYS_CONTEXT properly added to English public function catalog.The function entry (Line 77) is correctly added to the catalog table, and the documentation block (Lines 1142–1150) provides a clear description and consistent example with the Chinese version. Format and style align with existing function entries.
Also applies to: 1142-1150
CN/modules/ROOT/pages/master/6.4.1.adoc (1)
1-88: Chinese documentation mirrors English version with appropriate localization.The structure, implementation principles, and parameter documentation are comprehensive and consistent with the English version. The Chinese parameter tables provide thorough documentation of USERENV and SYS_SESSION_ROLES attributes. The function skeleton appropriately demonstrates the use of
SECURITY INVOKERfor privilege handling.
Summary by CodeRabbit