Notation change and corresponding code refactor: b bonds to a assets

Đang mở
  • Có gì không ổn?
#948 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
30/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
backend, documentation

Hướng nghiên cứu

The payload names no files. Start by searching the repository for the household budget constraint and the symbol b_{j,s,t} in docs, docstrings and code to see where the bonds notation appears. Rename it to a for assets, keeping the meaning of beginning-of-period wealth and the savings decision consistent. Done when no b-notation for bonds remains and the tests still pass. The issue has no comments or maintainer reply, so confirm the scope with maintainers first.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation

We propose changing the notation in the documentation, docstrings, and code the representation of wealth and savings from $b$ to $a$. The current notation uses the character $b$ indicative of "bonds". Examples include $b_{j,s,t}$ and $b_{j,s+1,t+1}$ in the household budget constraint. We propose changing the notation in the documentation and code to $a$ for "assets". Examples of the notation would be $a_{j,s,t}$ for wealth at the beginning of the period and $a_{j,s+1,t+1}$ for the savings decision.

cc: @jdebacker

Ngôn ngữ chính
Python
Star
85
Fork
153
Merge trung bình
1 ngày 19 giờ
Pull request đã merge (30 ngày)
19

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của PSLmodels/OG-Core

Tất cả issue của PSLmodels/OG-Core

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.