Logging framework - chapter outline #56
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
noelrivasc
changed the title
|
I realize this is a work in progress, but may I merge it as-is so I have material when I start rearranging order? |
Yes, that's perfect. |
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.
Description
This PR is a draft outline for the topic proposed in issue #13 : the logging framework.
Current state
The aim at this point is to present an outline that is enough to judge if the approach is adequate, and if the scope is sufficient for a chapter.
Under /iterations, the first two are drafted. The idea is for each of them to build on the previous one, improving the design while offering opportunities to demonstrate language features and use.
A note on the use of platforms
In #13, the latest suggestion is to write the logging framework using two platforms (CLI and web server) to compare and contrast, and show how the platform influences design.
The outline proposed only includes the CLI implementation. My reasoning is that the differences between the web server and cli platforms aren't big enough that we end up with very different designs. The cli implementation on its own brings good opportunities to highlight the relationship between Roc and the underlying platform, and different ways to handle that relationship.