Added docstrings to library flows for better documentation generation#44
Added docstrings to library flows for better documentation generation#44kpunwatk wants to merge 2 commits into
Conversation
kpunwatk
force-pushed
the
add-missing-flow-docstrings
branch
from
d0db0d2 to
641fcc4
Compare
kpunwatk
force-pushed
the
add-missing-flow-docstrings
branch
from
641fcc4 to
0dbb1c5
Compare
modified: nemoguardrails/library/autoalign/flows.v1.co modified: nemoguardrails/library/content_safety/flows.v1.co modified: nemoguardrails/library/crowdstrike_aidr/flows.v1.co modified: nemoguardrails/library/llama_guard/flows.v1.co modified: nemoguardrails/library/pangea/flows.v1.co modified: nemoguardrails/library/patronusai/flows.v1.co modified: nemoguardrails/library/self_check/input_check/flows.co modified: nemoguardrails/library/self_check/input_check/flows.v1.co modified: nemoguardrails/library/self_check/output_check/flows.co modified: nemoguardrails/library/self_check/output_check/flows.v1.co modified: nemoguardrails/library/topic_safety/flows.v1.co modified: nemoguardrails/library/trend_micro/flows.v1.co
kpunwatk
force-pushed
the
add-missing-flow-docstrings
branch
from
81e56ab to
91d9bf7
Compare
|
Hi @RobGeada pushed the changes, could you please review again, Thanks |
RobGeada
left a comment
RobGeada
left a comment
There was a problem hiding this comment.
What were the findings re. docstrings having semantic meaning in Colang V2 flows?
Yeah, Claude seems to suggest the following: In Colang V2, flow docstrings carry semantic meaning when the generation operator (...) is used. In such cases, the docstring is included in the LLM prompt as an instruction, rather than serving purely as documentation. From the documentation (docs/configure-rails/colang/usage-examples/bot-message-instructions.md): “In Colang 2.0, you use flow docstrings (Natural Language Descriptions) to provide instructions to the LLM. These docstrings are included in the prompt when the generation operator (...) is invoked.” The key distinction is: Flows with a generation operator (bot say ...)
Flows without a generation operator (most library flows)
I’ll analyze the library flows as well to check whether any of them need rewording. |
|
@RobGeada , the conclusion is that all docstrings added in this PR are purely documentary in nature.
|
2 participants
Description
We should ensure all flows have docstrings in their defining .co files so that better documentation can be generated. Right now, do not have docstrings so, added missing docstrings to library flows for better documentation generation
Related Issue(s)
Checklist