hub

https://github.com/mislav/hub

Go

A command-line tool that makes git easier to use with GitHub.

BlobViewer::Base#render_error

This method is used on the server side to check whether we can attempt to
render the blob at all. Human-readable error messages are found in the
`BlobHelper#blob_render_error_reason` helper.

This method does not and should not load the entire blob contents into
memory, and should not be overridden to do so in order to validate the
format of the blob.

Prefer to implement a client-side viewer, where the JS component loads the
binary from `blob_raw_path` and does its own format validation and error
rendering, especially for potentially large binary formats.

Source | Google | Stack overflow

Edit

git clone [email protected]:mislav/hub.git
cd hub
open

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-BlobViewer--Base-render_error-for-pr

# Commit to git

git add git commit -m "better docs for BlobViewer::Base#render_error"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-BlobViewer--Base-render_error-for-pr

hub pull-request

# Celebrate!