Skylint: report missing documentation for a function's return value

In addition to checking the function parameter documentation,
skylint now also checks whether the return value is documented in a
'Returns:' section in the docstring.

The same restrictions as for parameters apply:
- Private functions need no documentation
- If a function has a single line docstring, it need not document the
  return value.

In addition, I improved the docstring parsing:

- Previously, the beginning and end of a section (e.g. 'Args:',
  'Returns:') were determined by line breaks. Now, they're determined by
  indentation and missing line breaks are reported. This change should
  make the docstring parser more robust.
- Additional indentation is not warned against anymore.
  There are many situations where it makes sense, like example code.

Both of these changes were motivated by the results of the linter on
Skylark files "in the wild".

RELNOTES: none
PiperOrigin-RevId: 168660248
4 files changed
tree: 4c67f979256b0e637fe6a9e3c05eeb86ab1d5655
  1. examples/
  2. scripts/
  3. site/
  4. src/
  5. third_party/
  6. tools/
  7. .gitattributes
  8. .gitignore
  9. AUTHORS
  10. BUILD
  11. CHANGELOG.md
  12. combine_distfiles.py
  13. combine_distfiles_to_tar.sh
  14. compile.sh
  15. CONTRIBUTING.md
  16. CONTRIBUTORS
  17. ISSUE_TEMPLATE.md
  18. LICENSE
  19. README.md
  20. WORKSPACE
README.md

Bazel

{Fast, Correct} - Choose two

Build and test software of any size, quickly and reliably.

  • Speed up your builds and tests: Bazel only rebuilds what is necessary. With advanced local and distributed caching, optimized dependency analysis and parallel execution, you get fast and incremental builds.

  • One tool, multiple languages: Build and test Java, C++, Android, iOS, Go and a wide variety of other language platforms. Bazel runs on Windows, macOS, and Linux.

  • Scalable: Bazel helps you scale your organization, codebase and Continuous Integration system. It handles codebases of any size, in multiple repositories or a huge monorepo.

  • Extensible to your needs: Easily add support for new languages and platforms with Bazel's familiar extension language. Share and re-use language rules written by the growing Bazel community.

Getting Started

Documentation

Contributing to Bazel

See CONTRIBUTING.md

Build Status

Bazel is released in ‘Beta’. See the product roadmap to learn about the path toward a stable 1.0 release.