6

Documentation improvements by weiznich · Pull Request #2996 · diesel-rs/diesel ·...

 2 years ago
source link: https://github.com/diesel-rs/diesel/pull/2996
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

Copy link

Member

weiznich commented 27 days ago •

edited
  • Introduce a feature to use the unstable rustdoc cfg_attr feature and
    classify all public items acoordinoly
  • Introduce a
    i-implement-a-third-party-backend-and-opt-into-breaking-changes
    feature flag that is used to hide most of the previously hidden API
    behind this feature flag. The idea is that we can use this feature to
    communicate some documentation about implementing third party backends
    while making clear that we may break those API's potentially
  • Change the any macro generated code to only use public API's or
    explicitly as diesel::internal exported API's
  • Add a lot documentation in different places
  • Make diesel_derives use the with-deprecated/without-deprecated
    feature flags as well
  • Simplify the signature of Connection::load even more

Open points:

  • go again over the documentation
  • Inspect all ignored doc tests to see if they are building and if we could convert them to tests that are compiled
  • Fix any test failures
  • Maybe split up this commit into smaller ones
  • Fix merge conflict
  • Remove the doc building for the "special" branch

report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK