search

duct-framework / core

The core library of the Duct framework
76 stars 21 forks source link

Add missing docstring about default readers #30

Closed werenall closed 4 years ago

werenall commented 5 years ago

This PR simply adds missing mentions in a docstring documenting the default readers. Duct supports two new one but the docstring remains silent about them. It also mentions the newly added support in the CHANGELOG.

It also fixes the outdated version in the README.

weavejester commented 5 years ago

Thanks for the doc-string update, but I think we want to reference the fact that the new readers are equivalent to the metadata tags of the same name. So more something like:

  #duct/displace
  : equivalent to the metadata tag `^:displace`, but works on primative values
  #duct/replace
  : equivalent to the metadata tag `^:replace`, but works on primative values

That way we can put the documentation for the various metadata tags all in one place.

Can you also remove the CHANGELOG and README changes from the PR? I like to keep PRs focused on a single change.

werenall commented 5 years ago

Sure thing. But I'll do it tomorrow. I need to finish something else first.

werenall commented 5 years ago

Done @weavejester 😃