Repository navigation
docs(config): document the Domain enum (#1205 friction #9 / FEP-1023) - #1633
Merged
Merged
Conversation
wprazuch
force-pushed
the
wprazuch/ng-test-concurrency
branch
from
June 22, 2026 13:45
2fdee46 to
eebfcf8
Compare
wprazuch
force-pushed
the
wprazuch/domain-docstring
branch
from
June 24, 2026 07:01
b0918eb to
868cdb0
Compare
wprazuch
changed the base branch from
wprazuch/ng-test-concurrency
to
wprazuch/cli-clean-base
June 24, 2026 07:01
wprazuch
force-pushed
the
wprazuch/domain-docstring
branch
2 times, most recently
from
June 24, 2026 07:18
e80789d to
54e8888
Compare
Contributor
|
🌿 Preview your docs: https://nvidia-preview-wprazuch-domain-docstring.docs.buildwithfern.com/nemo/gym Here are the markdown pages you've updated: |
wprazuch
force-pushed
the
wprazuch/domain-docstring
branch
from
June 24, 2026 07:21
54e8888 to
f54d6be
Compare
marta-sd
previously approved these changes
Jun 24, 2026
wprazuch
force-pushed
the
wprazuch/domain-docstring
branch
from
June 24, 2026 09:08
f54d6be to
129e8d2
Compare
…ples) Epic #1205 friction #9 (FEP-1023 / M6d): add a docstring to the Domain enum describing what each value is for, with a recognizable example benchmark, plus guidance to prefer the most specific domain and use 'other' only as a catch-all. Surfaces on IDE hover / when reading config_types. A test enforces every value stays documented. Stacks on the unified-CLI base (martas/1434). Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
wprazuch
force-pushed
the
wprazuch/domain-docstring
branch
from
June 24, 2026 09:08
129e8d2 to
1d3f308
Compare
The surrounding docstrings render as markdown (triple-backtick bash code fences), where inline code uses a single backtick; switch the Domain enum values from double to single backticks to match. Update the doc-coverage test assertion accordingly. Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
marta-sd
approved these changes
Jun 24, 2026
ritaneves
pushed a commit
that referenced
this pull request
Jun 25, 2026
…#1633) ## What Adds a docstring to the `Domain` enum in `config_types.py` — a one-line description per value with a recognizable example benchmark, plus guidance to **pick the most specific domain** and use `other` only as a catch-all (addresses the [#600](#600) 'agent is too broad / no guidance' concern **without** redefining the taxonomy). ``` math — mathematical problem solving (e.g. AIME, MATH, GSM8K). coding — code generation, repair, or execution (e.g. SWE-bench, LiveCodeBench). agent — multi-step, tool-using tasks (e.g. tau2, workplace_assistant). Prefer a more specific value when it fits. ... (knowledge, instruction_following, long_context, safety, games, translation, e2e, rlhf, other) ``` ## Why Epic [#1205](#1205) friction 9 (naming confusion). Surfaces on IDE hover and when reading `config_types`; complements the inline `domain` comment added in #1597. ## Tests `test_domain_enum_documents_every_value` asserts every `Domain` value appears in the docstring, so a newly-added domain can't ship undocumented. --------- Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com> Signed-off-by: Rita Fernandes Neves <rfernandesne@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a docstring to the
Domainenum inconfig_types.py— a one-line description per value with a recognizable example benchmark, plus guidance to pick the most specific domain and useotheronly as a catch-all (addresses the #600 'agent is too broad / no guidance' concern without redefining the taxonomy).Why
Epic #1205 friction 9 (naming confusion). Surfaces on IDE hover and when reading
config_types; complements the inlinedomaincomment added in #1597.Tests
test_domain_enum_documents_every_valueasserts everyDomainvalue appears in the docstring, so a newly-added domain can't ship undocumented.