WIP: fix doc warnings #292
Conversation
|
Changes Unknown when pulling 130c23e on shizejin:fix_doc into ** on QuantEcon:master**. |
|
Changes Unknown when pulling 26c4eb7 on shizejin:fix_doc into ** on QuantEcon:master**. |
|
Changes Unknown when pulling 8817a97 on shizejin:fix_doc into ** on QuantEcon:master**. |
| @@ -276,8 +276,7 @@ def best_response(self, opponents_actions, tie_breaking='smallest', | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| opponents_actions : array_like(int or array_like(float)) or | |||
| array_like(int, ndim=1) or scalar(int) | |||
| opponents_actions : scalar(int) or array_like | |||
There was a problem hiding this comment.
Should this array_like be array_like(int or float)?
There was a problem hiding this comment.
Thank you for comments! I am wondering whether array_like(int or float) could cover array_like(array_like(float))? If this is the case, array_like(int or float) would be better.
There was a problem hiding this comment.
If we ignore the maximum length 72, it would have been
opponents_actions : scalar(int) or array_like(int, float, or array_like(foat))See #287 (comment).
There was a problem hiding this comment.
What do you think about the following format?
opponents_actions : scalar(int) or array_like
array_like can be array_like(int, float, or array_like(foat))
A profile of N-1 opponents' actions. If N=2, then it must be
a 1-dimensional array of floats (in which case it is treated
as the opponent's mixed action) or a scalar of integer (in
There was a problem hiding this comment.
What about this:
opponents_actions : scalar(int) or array_like
A profile of N-1 opponents' actions, represented by either
scalar(int), array_like(float), array_like(int), or
array_like(array_like(float)). If N=2, then it must be a
scalar of integer (in which case it is treated as the
opponent's pure action) or a 1-dimensional array of floats
(in which case it is treated as the opponent's mixed
action). If N>2, then it must be an array of N-1 objects,
where each object must be an integer (pure action) or an
array of floats (mixed action).
There was a problem hiding this comment.
@oyamad I agree - I think that is excellent.
|
Thanks @shizejin. This is a good PR. Just had one question above. |
|
Changes Unknown when pulling d69f156 on shizejin:fix_doc into ** on QuantEcon:master**. |
fixes #287
Fix unknown sections.