Skip to content

Commit

Permalink
add docstring for classhierarchy module
Browse files Browse the repository at this point in the history
Summary: removed the existing documentation since it just repeated signatures. if that's useful to anyone, let me know and ill keep it

Reviewed By: connernilsen

Differential Revision: D48127673

fbshipit-source-id: cd8e6776053cdf932335ebe237575d5d2ecc1870
  • Loading branch information
kinto0 authored and facebook-github-bot committed Aug 7, 2023
1 parent 9e6e6ae commit b9f6f16
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions source/analysis/classHierarchy.ml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
* LICENSE file in the root directory of this source tree.
*)

(* `edges` mapping from type index to a set of targets. `indices` mapping from annotation to its
vertex index. `annotations` inverse of `indices`. *)
(* The classHierarchy module contains an implementation of the C3 superclass linearization
algorithm. This algorithm (atopted in Python 2.3) is a way to determine an MRO (method resolution
order) which maintains certain properties. More can be found on
[wikipedia](https://en.wikipedia.org/wiki/C3_linearization) *)
open Core
open Ast
open Pyre
Expand Down

0 comments on commit b9f6f16

Please sign in to comment.