Skip to content

refactor: Add inline comments, remove info.xml#1155

Merged
DaveSkender merged 29 commits intov3from
inline-docs
Nov 11, 2024
Merged

refactor: Add inline comments, remove info.xml#1155
DaveSkender merged 29 commits intov3from
inline-docs

Conversation

@DaveSkender
Copy link
Owner

@DaveSkender DaveSkender commented Jan 28, 2024

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#10 record class where appropriate to maximize their utility / compatibility with streaming applications.

Done when:

  • wait, to rebase from v3 after merge of feat: Full chain streaming prototypes #1092
  • add a top-level Interface or virtual where needed to ensure mockable.
  • all info.xml files are replaced with inline XML comments using the /// convention, making good use of cref and <inheritdoc/> from the IStockIndicators interface descriptions.
  • all public classes have /// comments (e.g. utility, streaming classes)
  • ensure all public data classes are converted to record type where possible
  • restore use of [Serializable] attribute, if needed

@DaveSkender DaveSkender added the on hold On hold / waiting label Jan 28, 2024
@DaveSkender DaveSkender added this to the v3 milestone Jan 28, 2024
@DaveSkender DaveSkender changed the base branch from main to v3 January 28, 2024 06:57
@github-actions

This comment was marked as outdated.

@DaveSkender DaveSkender changed the title chore: Add inline comments, record types refactor: Add inline comments, record types Mar 3, 2024
@DaveSkender DaveSkender self-assigned this Mar 31, 2024
@DaveSkender DaveSkender removed the on hold On hold / waiting label Oct 30, 2024
@DaveSkender DaveSkender changed the title refactor: Add inline comments, record types refactor: Add inline comments, remove info.xml Nov 3, 2024
@DaveSkender DaveSkender marked this pull request as ready for review November 11, 2024 01:29
@DaveSkender DaveSkender merged commit c676ed9 into v3 Nov 11, 2024
@DaveSkender DaveSkender deleted the inline-docs branch November 11, 2024 02:10
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

1 participant