-
Notifications
You must be signed in to change notification settings - Fork 245
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
refactor: Add inline comments, remove info.xml
#1155
Draft
DaveSkender
wants to merge
19
commits into
v3
Choose a base branch
from
inline-docs
base: v3
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.
Draft
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
This comment was marked as outdated.
This comment was marked as outdated.
DaveSkender
changed the title
chore: Add inline comments, record types
refactor: Add inline comments, record types
Mar 3, 2024
Signed-off-by: Dave Skender <[email protected]>
Signed-off-by: Dave Skender <[email protected]>
28 tasks
DaveSkender
changed the title
refactor: Add inline comments, record types
refactor: Add inline comments, remove Nov 3, 2024
info.xml
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.
Description
The PR is primarily for code cleanup and to ensure wide consistent adoption of new conventions for inline XML commenting to replace the difficult to maintain
info.xml
files and to make better use of the new C#10record
class where appropriate to maximize their utility / compatibility with streaming applications.Done when:
v3
after merge of feat: Full chain streaming prototypes #1092Interface
orvirtual
where needed to ensure mockable.info.xml
files are replaced with inline XML comments using the///
convention, making good use ofcref
and<inheritdoc/>
from theIStockIndicators
interface descriptions.///
comments (e.g. utility, streaming classes)record
type where possible[Serializable]
attribute, if needed