Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 28, 2025

The documentation incorrectly referenced the background cancellable task computation expression as cancellableBackgroundTask when the correct name is backgroundCancellableTask.

This affected two documentation files:

  • README.md - line 17 in the CancellableTask section
  • docsSrc/index.md - line 16 in the CancellableTask section

The actual computation expression builder is defined in src/IcedTasks/CancellableTask.fs as:

let backgroundCancellableTask = BackgroundCancellableTaskBuilder()

This fix ensures the documentation matches the actual implementation and provides users with the correct computation expression name to use in their code.

Fixes issue where users following the documentation would get compilation errors when trying to use the incorrectly named cancellableBackgroundTask computation expression.

Original prompt

This section details on the original issue you should resolve

<issue_title>Fix documentation</issue_title>
<issue_description>Hello, I discovered something wrong in documentation. In docs, for background cancellable task, you need to use cancellableBackgroundTask, but the correct name is backgroundCancellableTask. Maybe there are other mispelled computation expressions, but didn't checked them :)</issue_description>

<agent_instructions>Focus solely on fixing the documentation in docsSrc or README. Do not change any source code. </agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes #56

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI changed the title [WIP] Fix documentation Fix documentation: Change cancellableBackgroundTask to backgroundCancellableTask Sep 28, 2025
Copilot AI requested a review from TheAngryByrd September 28, 2025 19:29
@TheAngryByrd TheAngryByrd marked this pull request as ready for review September 28, 2025 19:33
@TheAngryByrd TheAngryByrd merged commit 6b4ed2a into master Sep 28, 2025
14 checks passed
@TheAngryByrd TheAngryByrd deleted the copilot/fix-76237ed7-a77c-4457-a368-e7a5369ae336 branch September 28, 2025 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation

2 participants