QuantEcon / QuantEcon/QuantEcon.py

repeated names in directory

Open
#350 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discuss
Dominant language
Python
Stars
2.4k
Forks
2.3k
Avg merge
3d 3h
Merged PRs (30d)
3

Description

There are a lot of repeated names in the list of attributes, filename and then class or function name:

ss

e.g., compute_fixed_point and compute_pf, ECDF and ecdf. We don't really need the module names here. Should they be hidden, perhaps? What's the convention?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source file, test, or entry point is named. Start by identifying the component that produces the attribute directory shown in the screenshot, then compare entries such as compute_fixed_point/compute_pf and ECDF/ecdf. Done requires a documented convention and an agreed decision on whether module names should be hidden.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.