-
Notifications
You must be signed in to change notification settings - Fork 30
DOC-1638 Add multiple edge section #352
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
Open
priyankagunaki-cloud
wants to merge
1
commit into
4.3
Choose a base branch
from
DOC-1638-add-info-multiple-edge
base: 4.3
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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.
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.
@priyankagunaki-cloud The ticket said to add a section, so you did. Now consider the resulting page.
You have a new Heading 3 section about Multi-edges, which describes why they are useful and then says the way to create them is with a Discriminator. There is an example, which was copied from the Discriminator section. This is immediately followed by a Heading 3 section (same level) which describes Discriminators. It again shows the same example.
Does this not seem redundant to you?
This is why I say do not blindly follow tickets. A ticket is trying to describe a problem or need. Understand the need, then figure out the best way to address it. The person who wrote the ticket may not have put in the time to understand the full context, or they may not be the best writer or explainer.