Skip to content
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

Xml doc comment cleanup #220

Closed
wants to merge 19 commits into from
Closed

Xml doc comment cleanup #220

wants to merge 19 commits into from

Conversation

abelbraaksma
Copy link
Member

@abelbraaksma abelbraaksma commented Dec 22, 2023

Just some cleanup from discussions in #219.

@bartelink feel free to commit to this branch if you have better wording for some doc comments. You mentioned yesterday you wanted to give some of it another look.

@abelbraaksma
Copy link
Member Author

abelbraaksma commented Dec 22, 2023

I just noticed that some functions don't have a <returns> element in the doc xml (like length or lengthBy functions). I'll check that tomorrow (well, later in the AM of today, that is, unless you beat me to it ;).

@bartelink
Copy link
Member

Hm not sure I have push rights (have pushed to https://github.com/bartelink/FSharp.Control.TaskSeq/tree/doc-cleanup instead for now)

@abelbraaksma
Copy link
Member Author

@bartelink can you try again? I upped your rights, you should be allowed to push (but not sure that allows you to push on other branches). Otherwise, we can always take a merge from your fork.

Copy link
Member Author

@abelbraaksma abelbraaksma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just this one for now, will look more into the rest.

src/FSharp.Control.TaskSeq/TaskSeqInternal.fs Outdated Show resolved Hide resolved
@abelbraaksma abelbraaksma added enhancement New feature or request refactoring Cleanup, refactoring and minor fixes cleanup labels Dec 24, 2023
@abelbraaksma
Copy link
Member Author

abelbraaksma commented Mar 15, 2024

These changes form an integral part of this continuation-PR: #234. With few exceptions, all changes have been accepted (there, commits were squashed for cleaner history).

@abelbraaksma abelbraaksma deleted the doc-cleanup branch March 17, 2024 01:59
@abelbraaksma abelbraaksma added this to the v0.4.0 milestone Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup enhancement New feature or request refactoring Cleanup, refactoring and minor fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants