Show details in the builddict.

Review Request #3708 — Created April 17, 2016 and submitted

benjyw
pants
3018
pants-reviews
zundel
Previously we only used the first line of a docstring as the description.
Now we take any subsequent lines as details, and display them on expansion.

CI away: https://travis-ci.org/pantsbuild/pants/builds/123658706

See the results here: http://pantsbuild.github.io/staging/builddict_details/build_dictionary.html

  • 0
  • 0
  • 1
  • 0
  • 1
Description From Last Updated
  1. This is great!

  2. I'm not sure why they were marked :API: public

    Its fine by me to remove these but maybe Twitter has some kind of extension built to it? Add molsen@ to the review

    1. I tracked this back to the commit in which they were marked public, and there was no good reason for it. Stu actually commented on that commit that these shouldn't be public, but it was too late. Matt is going to revisit Stu's comments and remove many of the markers it added.

  3. There are a few new things I noticed in the rendered page at http://pantsbuild.github.io/staging/builddict_details/build_dictionary.html

    1) Some of the format strings have markdown in them. the markdown looks like its being escaped, e.g. do Expand All and look for three backticks (I'm seeing it in the definition of scoped()

    2) I see quite a few instances of some parameters not formatted correctly. do Expand all and serch for :param My guess is that there is something wrong with the pydoc strings in these case and we were missing these parameters before.

    1. Yes, this was true before as well. We need to go over all the docstrings and make sure they render OK, either by modifying the renderer or the docstrings. But that's out-of-scope for this change.

  4. 
      
Review request changed

Status: Closed (submitted)

Change Summary:

3e9e103c1d6f32f5a40f8a94a240b03221ba2bea

Loading...