Documentation and cleanup #78
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…the timestamp stored in the point
This is a "breaking change" and so there's a case for making a major version bump here, but at this stage I think we're pretty safe to cowboy it - nothing uses or should use the Event type anymore in the Vaultaire-and-associated codebases, and it's very unlikely that anyone else would be relying on the presence of a dead sum type at this stage.
olorin
changed the title
| @@ -390,12 +392,15 @@ dayMapsFromCeph origin' = do | |||
| Right day_map -> | |||
| return $ Right (fromIntegral (BS.length contents), day_map) | |||
|
|
|||
| -- | Ceph object ID of the origin's Simple DayMap. | |||
| simpleDayOID :: Origin -> ByteString | |||
| simpleDayOID (Origin origin') = "02_" `BS.append` origin' `BS.append` "_simple_days" | |||
There was a problem hiding this comment.
I would probably have used <> here if I had known of it's greatness back then. No need to change now.
There was a problem hiding this comment.
Ah, I missed that one - updated.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Going through and adding missing toplevel Haddock comments, rewriting any that seem terse or unclear, and fixing some minor style/formatting issues as I come across them.
The one nontrivial refactoring made is to remove the (exported) Event type, which is dead code with no remaining use. @christian-marie and I decided that it wouldn't be too terrible to cowboy this into a patch release at this stage of maturity, as the probability of anyone having used it is negligible.
The refactor involves replacing explicit ByteString.appends with mappends; any objections to that?