search

AI4Finance-Foundation / FinRL-Meta

FinRL­-Meta: Dynamic datasets and market environments for FinRL.
https://ai4finance.org
MIT License
1.2k stars 560 forks source link

Missing doc strings #200

Closed eyast closed 1 year ago

eyast commented 2 years ago

Functions have missing doc strings,

YangletLiu commented 1 year ago

This issue seems to be not clear.

eyast commented 1 year ago

Why is this closed please ?

From: Xiao-Yang Liu @.> Sent: Saturday, August 13, 2022 8:53:48 PM To: AI4Finance-Foundation/FinRL-Meta @.> Cc: Eyas Taifour @.>; Author @.> Subject: Re: [AI4Finance-Foundation/FinRL-Meta] Missing doc strings (Issue #200)

Closed #200https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAI4Finance-Foundation%2FFinRL-Meta%2Fissues%2F200&data=05%7C01%7Ceyast%40microsoft.com%7C4a0a221d6ae14d6cfb1e08da7d1a1a13%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637959848339445337%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=XL1GieUX9t0GB9ysK5rwVk5pmTRFlKf2RtkipTiSPkM%3D&reserved=0 as completed.

— Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAI4Finance-Foundation%2FFinRL-Meta%2Fissues%2F200%23event-7183205820&data=05%7C01%7Ceyast%40microsoft.com%7C4a0a221d6ae14d6cfb1e08da7d1a1a13%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637959848339445337%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=feflij%2BYU2T7z2kNb2A3ou4%2BcejJ%2F%2FW0ltK4KH5dXBk%3D&reserved=0, or unsubscribehttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FALUEL5B4QPNLXXUPGA5JFPLVY55DZANCNFSM53RTQWHA&data=05%7C01%7Ceyast%40microsoft.com%7C4a0a221d6ae14d6cfb1e08da7d1a1a13%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637959848339445337%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=Dk2ctqE6le8VhlbKm9SvZaozfl7c%2F2WNVqzvTOgBm%2F0%3D&reserved=0. You are receiving this because you authored the thread.Message ID: @.***>

YangletLiu commented 1 year ago

Could you please explain "Missing doc strings"? I was not able to understand, thought it is not a serious issue and no one joined.... If you think it is important, let us re-open it, and I can invite members to fix it with you.

eyast commented 1 year ago

We need to add costrings to all the functions :)

From: Xiao-Yang Liu @.> Sent: Saturday, August 13, 2022 8:53:34 PM To: AI4Finance-Foundation/FinRL-Meta @.> Cc: Eyas Taifour @.>; Author @.> Subject: Re: [AI4Finance-Foundation/FinRL-Meta] Missing doc strings (Issue #200)

This issue seems to be not clear.

— Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAI4Finance-Foundation%2FFinRL-Meta%2Fissues%2F200%23issuecomment-1214137357&data=05%7C01%7Ceyast%40microsoft.com%7Ca510c57236b5476498b108da7d1a121d%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637959848214853204%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=2MbGMN%2FiqI1hnTOx1g%2B%2BvGDxNfxsugntEIM8yqAhlqk%3D&reserved=0, or unsubscribehttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FALUEL5EORGBPON6SCLQLME3VY55C5ANCNFSM53RTQWHA&data=05%7C01%7Ceyast%40microsoft.com%7Ca510c57236b5476498b108da7d1a121d%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637959848214853204%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=NvXlst2ALSZ1bt8P2lsXWNY10AKoUGswlFlbndaXYcE%3D&reserved=0. You are receiving this because you authored the thread.Message ID: @.***>