Skip to content

Document DiffContext and DiffOutput#23

Merged
ddssff merged 9 commits into
seereason:masterfrom
tweag:ninioArtillero/docs2
May 7, 2026
Merged

Document DiffContext and DiffOutput#23
ddssff merged 9 commits into
seereason:masterfrom
tweag:ninioArtillero/docs2

Conversation

@ninioArtillero
Copy link
Copy Markdown
Contributor

@ninioArtillero ninioArtillero commented Apr 22, 2026

This PR adds documentation the Data.Algorithm.DiffContext and Data.Algorithm.DiffOutput, including

  • Some missing toplevel haddocks.
  • Local function signatures.
  • Some local function haddocks.
  • In place comments detailing the implementation.
  • diffs to acc and context to contextSize variable name changes to implicitly document their role within the corresponding function bodies.
  • Removed commented groupBy import from DiffContext.

@ninioArtillero ninioArtillero force-pushed the ninioArtillero/docs2 branch 3 times, most recently from 6bd5203 to 9fb23fd Compare April 22, 2026 18:07
Copy link
Copy Markdown
Contributor

@facundominguez facundominguez left a comment

Choose a reason for hiding this comment

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

Hello! The comments are helpful. I'm contributing some more suggestions.

Comment thread src/Data/Algorithm/DiffContext.hs Outdated
Comment thread src/Data/Algorithm/DiffContext.hs Outdated
Comment thread src/Data/Algorithm/DiffContext.hs Outdated
Comment thread src/Data/Algorithm/DiffOutput.hs Outdated
Comment thread src/Data/Algorithm/DiffOutput.hs
Comment thread src/Data/Algorithm/DiffOutput.hs Outdated
Comment thread src/Data/Algorithm/DiffOutput.hs
Comment thread src/Data/Algorithm/DiffOutput.hs Outdated
ninioArtillero and others added 4 commits April 22, 2026 16:40
Co-authored-by: Facundo Domínguez <facundo.dominguez@tweag.io>
Co-authored-by: Facundo Domínguez <facundo.dominguez@tweag.io>
Co-authored-by: Facundo Domínguez <facundo.dominguez@tweag.io>
Co-authored-by: Facundo Domínguez <facundo.dominguez@tweag.io>
Co-authored-by: Facundo Domínguez <facundo.dominguez@tweag.io>
Comment thread src/Data/Algorithm/DiffContext.hs Outdated
Comment thread src/Data/Algorithm/DiffContext.hs
Comment thread src/Data/Algorithm/DiffContext.hs
Comment thread src/Data/Algorithm/DiffContext.hs
Co-authored-by: Facundo Dominguez <facundo.dominguez@tweag.io>
@ninioArtillero ninioArtillero changed the title Add documentation to DiffContext and DiffOutput Document DiffContext and DiffOutput Apr 30, 2026
@ninioArtillero
Copy link
Copy Markdown
Contributor Author

@ddssff We are done updating this PR, so this is ready for review at your earliest convenience. Willing to make/discuss any requested change.

@ddssff
Copy link
Copy Markdown
Member

ddssff commented May 7, 2026

Merging. I love this meticulous and articulate treatment of the algorithm.

@ddssff ddssff closed this May 7, 2026
@ddssff ddssff reopened this May 7, 2026
@ddssff ddssff merged commit f772d46 into seereason:master May 7, 2026
24 checks passed
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.

3 participants