[flags] FFL-1145: Update documentation#2955
Merged
jonathanmos merged 2 commits intoOct 30, 2025
Merged
Conversation
jonathanmos
changed the title
typotter
force-pushed
the
typo/FFL-1184-resolve-value-method
branch
2 times, most recently
from
October 21, 2025 07:32
9c296a3 to
a73b2bd
Compare
jonathanmos
force-pushed
the
jmoskovich/ffl-1145/documentation
branch
from
October 21, 2025 10:04
8dc4676 to
d46a0c6
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## feature/feature-flagging #2955 +/- ##
============================================================
+ Coverage 70.87% 70.91% +0.04%
============================================================
Files 841 841
Lines 30577 30577
Branches 5168 5168
============================================================
+ Hits 21670 21681 +11
+ Misses 7447 7433 -14
- Partials 1460 1463 +3 🚀 New features to boost your workflow:
|
jonathanmos
marked this pull request as ready for review
October 21, 2025 10:56
0xnm
previously approved these changes
Oct 21, 2025
0xnm
left a comment
0xnm
left a comment
Member
There was a problem hiding this comment.
LGTM. It would be nice to get a look from @DataDog/documentation as well.
| - `reason: String?` - Optional explanation of why this value was resolved | ||
| - `errorCode: ErrorCode?` - Optional error code (null indicates success) | ||
| - `errorMessage: String?` - Optional human-readable error message | ||
| - `flagMetadata: Map<String, Any>?` - Optional metadata associated with the flag |
Member
There was a problem hiding this comment.
I think it will be better to have empty collection here instead of null value.
jonathanmos
force-pushed
the
jmoskovich/ffl-1145/documentation
branch
from
October 21, 2025 14:05
d46a0c6 to
a7bcdba
Compare
Contributor
|
Created DOCS-12384 for documentation team review |
Base automatically changed from
typo/FFL-1184-resolve-value-method
to
feature/feature-flagging
October 22, 2025 17:15
rtrieu
previously approved these changes
Oct 29, 2025
rtrieu
left a comment
rtrieu
left a comment
Contributor
There was a problem hiding this comment.
left some minor feedback for your consideration!
0xnm
approved these changes
Oct 30, 2025
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
5 participants
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 does this PR do?
Adds comprehensive documentation for setup and usage of the flags module to the readme. We may remove this when public documentation becomes available in order to match what we have in the other modules.
Motivation
What inspired you to submit this pull request?
Additional Notes
Anything else we should know when reviewing?
Review checklist (to be filled by reviewers)