QuantEcon / QuantEcon/lecture-python.myst
CapWords convention for class names
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 123
- Forks
- 57
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 11
Description
PEP8 writes
Class names should normally use the CapWords convention.
There are a few cases that do not follow this in two_auctions and house_auction (there may be other such files):
https://github.com/QuantEcon/lecture-python.myst/blob/22983b3ff41f43ac67a9bd14e3c0042069162155/lectures/two_auctions.md?plain=1#L550
https://github.com/QuantEcon/lecture-python.myst/blob/22983b3ff41f43ac67a9bd14e3c0042069162155/lectures/house_auction.md?plain=1#L672
https://github.com/QuantEcon/lecture-python.myst/blob/22983b3ff41f43ac67a9bd14e3c0042069162155/lectures/house_auction.md?plain=1#L1214
Consider changing to BidPriceSolution and so on.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the referenced class definitions in lectures/two_auctions.md and lectures/house_auction.md, then search those lecture files for other class names that do not use CapWords. Rename the identified classes, including BidPriceSolution and the other examples, and update their references so the lectures remain consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100