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.

Sign up for GitHub

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

Jump to bottom

docs: improve documentation for FileSystemStream #971

Merged
merged 3 commits into from
Apr 18, 2023
Merged

docs: improve documentation for FileSystemStream #971

merged 3 commits into from
Apr 18, 2023

Conversation

vbreuss
Copy link
Member

@vbreuss vbreuss commented Apr 16, 2023

Fixes #943:

The XML docs say Wraps the <see cref="FileStream" />, but the wrapped field, _stream, is of type Stream. There's no runtime check to ensure that the stream provided in the constructor is of type FileStream. This is confusing because the docs state one thing, but the implementation doesn't seem to match that.

@vbreuss vbreuss changed the title doc: improve documentation for FileSystemStream docs: improve documentation for FileSystemStream Apr 16, 2023
@mergify mergify bot merged commit 8ad2e98 into TestableIO:main Apr 18, 2023
@vbreuss vbreuss deleted the topic/vb/doc-fix-for-943 branch April 18, 2023 11:36
vbreuss referenced this pull request in Testably/Testably.Abstractions Apr 19, 2023
@renovate
chore(deps): update dependency testableio.system.io.abstractions to v…
c688c2d 
…19.2.15 (#296)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[TestableIO.System.IO.Abstractions](https://togithub.com/TestableIO/System.IO.Abstractions)
| nuget | patch | `19.2.11` -> `19.2.15` |

---

### Release Notes

<details>
<summary>TestableIO/System.IO.Abstractions</summary>

###
[`v19.2.15`](https://togithub.com/TestableIO/System.IO.Abstractions/releases/tag/v19.2.15)

##### What's Changed

- docs: improve documentation for `FileSystemStream` by
[@&#8203;vbreuss](https://togithub.com/vbreuss) in
[https://github.com/TestableIO/System.IO.Abstractions/pull/971](https://togithub.com/TestableIO/System.IO.Abstractions/pull/971)
- fix: update Name of `DirectoryInfo` when using `MoveTo` by
[@&#8203;vbreuss](https://togithub.com/vbreuss) in
[https://github.com/TestableIO/System.IO.Abstractions/pull/972](https://togithub.com/TestableIO/System.IO.Abstractions/pull/972)

**Full Changelog**:
TestableIO/System.IO.Abstractions@v19.2.13...v19.2.15

###
[`v19.2.13`](https://togithub.com/TestableIO/System.IO.Abstractions/releases/tag/v19.2.13)

##### What's Changed

- fix: always keep `FileAttributes.Directory` on directories by
[@&#8203;vbreuss](https://togithub.com/vbreuss) in
[https://github.com/TestableIO/System.IO.Abstractions/pull/970](https://togithub.com/TestableIO/System.IO.Abstractions/pull/970)

**Full Changelog**:
TestableIO/System.IO.Abstractions@v19.2.12...v19.2.13

###
[`v19.2.12`](https://togithub.com/TestableIO/System.IO.Abstractions/releases/tag/v19.2.12)

##### What's Changed

- fix: throw IOException when creating a directory with a conflicting
file by [@&#8203;vbreuss](https://togithub.com/vbreuss) in
[https://github.com/TestableIO/System.IO.Abstractions/pull/969](https://togithub.com/TestableIO/System.IO.Abstractions/pull/969)

**Full Changelog**:
TestableIO/System.IO.Abstractions@v19.2.11...v19.2.12

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/Testably/Testably.Abstractions).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS40OS4wIiwidXBkYXRlZEluVmVyIjoiMzUuNDkuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@github-actions
Copy link

This is addressed in release v19.2.15.

@github-actions github-actions bot added the state: released Issues that are released label Apr 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fgreinacher fgreinacher fgreinacher approved these changes

Assignees
No one assigned
Labels
state: released Issues that are released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

FileSystemStream Issues
3 participants
@vbreuss @fgreinacher @vbtig