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

minor cleanups #364

Merged
merged 1 commit into from
Jan 5, 2024
Merged

minor cleanups #364

merged 1 commit into from
Jan 5, 2024

Conversation

Ptival
Copy link
Contributor

@Ptival Ptival commented Jan 5, 2024

No description provided.

@Ptival Ptival requested a review from RyanGlScott January 5, 2024 21:12
Comment on lines 1290 to 1293
-- | Return the memory contents from a given offset, that is, the `MemChunk` at
-- the given offset, then the following `MemChunk`s until the end of the
-- segment. Returns a `MemoryError` if the requested offset falls within a
-- relocation, which we cannot partition.
Copy link
Contributor

Choose a reason for hiding this comment

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

Although backticks will technically work, the usual Haddock idiom for hyperlinking identifiers is to use single quotes:

Suggested change
-- | Return the memory contents from a given offset, that is, the `MemChunk` at
-- the given offset, then the following `MemChunk`s until the end of the
-- segment. Returns a `MemoryError` if the requested offset falls within a
-- relocation, which we cannot partition.
-- | Return the memory contents from a given offset, that is, the 'MemChunk' at
-- the given offset, then the following 'MemChunk's until the end of the
-- segment. Returns a 'MemoryError' if the requested offset falls within a
-- relocation, which we cannot partition.

@Ptival Ptival force-pushed the vr/minor-cleanups branch from 47819d8 to f8f406d Compare January 5, 2024 21:26
@Ptival Ptival merged commit c8a8845 into master Jan 5, 2024
3 checks passed
@Ptival Ptival deleted the vr/minor-cleanups branch January 5, 2024 21:27
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.

2 participants