Rewrite project's documentation and more #48
Conversation
This file contains hidden or 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
Add it to you git config via > git config blame.ignoreRevsFile .git-blame-ignore-revs
Add references, fix tabulations, improve code examples
Who uses this format? Why should I wait to generate something not needed
The macro `Ewebmachine.Builder.Handlers.ping/1` and the function `Ewebmachine.Handlers.ping/2` were/are both intended for testing however were public for no reason. Moreover, the decision tree now only calls the ping handler when `Mix.env()` returns test, removing a useless handler call for production code.
Ewebmachine is now only compatible with version 1.13.4 or later therefore this compatibility layer with version 1.4.0 is no longer needed.
Inline the macro's content as there is only one call site and its content is only two imports.
Ewebmachine.Events module shouldn't be visible as their only purpose is for internal usage.
Enough with having a partial documentation where I need to read the whole moduledoc to find what I need. Let's use ex_doc group feature for module and function to ease the navigation and have a README which explains core concepts. resolve #45
Let's have the same order everywhere for this attribute. I want to know quickly if the module is visible or not and avoid searching this information beneath implementation comments.
This function should be private as its only for internal usage.
Make the implicit stands out as explicit especially by replacing the usage of the Access protocol by the `Keyword.fun` dedicated function. Also checks that given option are what they should be, a nice improvements that will halt the compiler on invalid options values.
Use function head matching instead of using if which nest the implementation for nothing.
…AsException exception
This handler shouldn't exist in the first place but it's there for some reason. Removing it would introduced a breaking change as content_types_provided would have no function to make a body. Changing its content-type to text/plain could be a solution but it changes the behaviour of every resource which uses the default handler. Therefore we are kind of stuck with this for now.
This dependency shouldn't be added by Ewebmachine but by the consumer of the library itself (even though there is only two options in the wild for now).
Now that the documentation explains the concept in a way that a newcomer can understand the concepts, we no longer need an example project.
Krapaince
force-pushed
the
improvements
branch
from
d486c13 to
b9e1d93
Compare
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.
mix formatAdd documentation on handlers macro fromdropped becauseEwebmachine.Builder.HandlersCode.fetch_docsonly works once.beamfiles are written to disk which happens only when all modules are compiledand other commits cleaning the project