Misc doc changes #2
Conversation
|
Hello @kianmeng |
List of changes: - Set readme as default html doc page - Use common source url - Always get latest greatest ex_doc version - Badges and more badges! - Fix indentation
kianmeng
force-pushed
the
misc-doc-changes
branch
from
8c1e167
to
871d444
Compare
@flowerett Done. 😃 |
|
@flowerett Let me know if there are additional changes. Feel free to amend it to your needs. Remember to squash all commits before merging. 😄 |
README.md
Outdated
| @@ -21,31 +25,14 @@ def deps do | |||
| end | |||
| ``` | |||
|
|
|||
| ## Basic Usage | |||
| <!-- MDOC !--> | |||
There was a problem hiding this comment.
This looks hacky, not sure if I like this.
There was a problem hiding this comment.
This looks hacky, not sure if I like this.
Removed.
lib/ecto_vista.ex
Outdated
| Use the `refresh/0` function | ||
| It will run `REFRESH MATERIALIZED VIEW [view_name];` query. | ||
| #{ | ||
| readme |
There was a problem hiding this comment.
Maybe we don't need all docs here, just a short introduction for the module.
But reading from file and removing injected stop keys seems to be too much.
There was a problem hiding this comment.
Maybe we don't need all docs here, just a short introduction for the module.
But reading from file and removing injected stop keys seems to be too much.
Agree. Since the generated doc for Ecto.Vista does not contains any information relevant to user like functions or callback list. See screenshot below.
Come to think of it, perhaps we should just simple ignore this Ecto.Vista and set it to @moduledoc false since it does not convey any helpful information (shown in screenshot above). Unless, you've plan to add more details?
I've set the main page back to readme since right now it contains all the usage doc.
Let me know.
| @@ -2,65 +2,6 @@ defmodule EctoVista do | |||
| @moduledoc """ | |||
| Provides the macros and functions to define and manage | |||
| PostgreSQL views with Ecto. | |||
|
|
|||
| ## Using EctoVista | |||
There was a problem hiding this comment.
I was just thinking again about it and come to conclusion that I would prefer more meaningful changes than just moving from one file to another.
If you don't mind I'll revert the docs part of your PR
|
@flowerett Any updates on this? |
List of changes: