This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
Improve documentation for EventContext fields #6319
Merged
Conversation
This file contains 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
richvdh
force-pushed
the
rav/event_context/1
branch
2 times, most recently
from
96f4455 to
b70e641
Compare
richvdh
force-pushed
the
rav/event_context/1
branch
from
b70e641 to
069098d
Compare
erikjohnston
approved these changes
Nov 5, 2019
| For a *rejected* state event, where the state of the rejected event is | ||
| ignored, this state_group should never make it into the | ||
| event_to_state_groups table. Indeed, inspecting this value for a rejected | ||
| state event is almost certainly incorrect. |
There was a problem hiding this comment.
(I wonder if we should make accessing state_group raise if its rejected)
There was a problem hiding this comment.
well who knew, this identified a bug. I'm going to pull this out to a separate PR.
erikjohnston
reviewed
Nov 5, 2019
| For an outlier, where we don't have the state at the event, this will be | ||
| None. | ||
|
|
||
| prev_group: If it is known, ``state_group``'s prev_group. Note that this being |
There was a problem hiding this comment.
Might be worth noting that this is not the state group associated with prev_state_ids
Per review comments: add some sanity checks on accessing state_group etc for rejected events.
This reverts commit f84119b. This turned out to identify some bugs, so I'm going to pull the whole lot out to a separate PR.
babolivier
pushed a commit
that referenced
this pull request
Sep 1, 2021
* commit '408600282': Improve documentation for EventContext fields (#6319)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.