Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documenting self.results dictionary

See original GitHub issue

In all of our classes we put stuff in the self.results dictionary, but we are not adding any information about self.results to our docstrings. We should probably do something about that. Pointed out by @hartle.

Issue Analytics

State:
Created 5 years ago
Comments:11

Top GitHub Comments

1reaction

sdmccabecommented, Feb 27, 2019

I tend to agree that weights would be preferable to matrix. matrix on first read would seem to be the adjacency matrix of the graph, but it’s not; typically it’s a dense matrix of weights.

0reactions

sdmccabecommented, Mar 12, 2019

Closing this but we should revisit the immutability of self.results at a later date.

Top Results From Across the Web

You Probably Don't Need a Data Dictionary

While efforts to build a data dictionary are often undertaken out of a ... A self-documenting and searchable code-base; A knowledge-base or ...

reduce(into:_:) | Apple Developer Documentation

Returns a new dictionary containing only the key-value pairs that have non- nil values as the result of transformation by the given closure....

self-documenting code - Encyclopedia - The Free Dictionary

self-documenting code ... A sequence of programming statements that are simple and straightforward and can be readily implemented by another programmer. McGraw- ...

Dictionary.com | Meanings and Definitions of Words at ...

In Dictionary.com's modern language section, we're constantly documenting the meanings of slang, emoji, and new words as soon as you all start saying...

corpora.dictionary – Construct word<->id mappings

Document frequencies: token_id -> how many documents contain this token. ... missing tokens (tokens present in document but not in self) with frequencies?...