Skip to content

[ak2] Editorial Suggestions (carried over from intro repo #491) #883

@jstac

Description

@jstac

This issue bundles the remaining unchecked editorial items from QuantEcon/lecture-python-intro#491. The ak2 lecture was removed from lecture-python-intro in QuantEcon/lecture-python-intro#549 and now lives here, so the open suggestions are being re-filed against this repo for triage.

The section/equation numbers below reference the version of the lecture as it stood when the original issue was filed; reviewers should map them to the current section structure here.

Content

  • Starting from section 31.10.4, reconsider plotting a graph for every single variable — keep graphs only for those that are discussed in the surrounding text. The graphs are dense and hard to read, and the prose doesn't clearly explain the conclusion being drawn from each figure. Tighten the link between figures and the explanation below them.

Code

  • For the code block in section 30.10.3, remove the class wrapper and refactor to plain functions.
  • Convert the plotting code to the object-oriented matplotlib API. Search for uses of plt.<...> and replace with fig, ax = plt.subplots() / ax.<...> style. Use the default figure size, make the plotting code stand out clearly, and let matplotlib pick colours rather than hard-coding them.

Context

Originally filed by @Jiarui-ZH at QuantEcon/lecture-python-intro#491 with comments from @pgrosser1. Items already done in the original issue (rephrasing around equations 31.3 and 31.8, replacing njit usage) were addressed before the lecture moved, so they aren't repeated here. The related sub-issue QuantEcon/lecture-python-intro#507 is closed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions