René's URL Explorer Experiment


Title: documentation of commands/arguments · Issue #114 · google/python-fire · GitHub

Open Graph Title: documentation of commands/arguments · Issue #114 · google/python-fire

X Title: documentation of commands/arguments · Issue #114 · google/python-fire

Description: I have some questions/comments on the "user friendliness" of fire. With the following script fire_test.py import fire class Example(object): """this is an example module with some functions""" def hello(self, name, message="hello", count...

Open Graph Description: I have some questions/comments on the "user friendliness" of fire. With the following script fire_test.py import fire class Example(object): """this is an example module with some functions""" def ...

X Description: I have some questions/comments on the "user friendliness" of fire. With the following script fire_test.py import fire class Example(object): """this is an example module wi...

Opengraph URL: https://github.com/google/python-fire/issues/114

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"documentation of commands/arguments","articleBody":"I have some questions/comments on the \"user friendliness\" of fire.\r\n\r\nWith the following script `fire_test.py`\r\n```\r\nimport fire\r\n\r\n\r\nclass Example(object):\r\n    \"\"\"this is an example module with some functions\"\"\"\r\n\r\n    def hello(self, name, message=\"hello\", count=3):\r\n        \"\"\"Says count times the message to the specified name\r\n\r\n        :param name (str): the name of the person\r\n        :param message (str): the message to say to the person\r\n        :param count (int): the number of times the message should be repeated\r\n        :return: the expected result\r\n        \"\"\"\r\n        return 'Hello {name}!'.format(name=name) * count\r\n\r\n\r\nif __name__ == '__main__':\r\n    fire.Fire(Example)\r\n```\r\nthe call to `python fire_test.py hello` returns\r\n```\r\nFire trace:\r\n1. Initial component\r\n2. Instantiated class \"Example\" (fire_test.py:4)\r\n3. Accessed property \"hello\" (fire_test.py:7)\r\n4. ('The function received no value for the required argument:', 'name')\r\n\r\nType:        method\r\nString form: \u003cbound method Example.hello of \u003c__main__.Example object at 0x0000000002A2F9E8>>\r\nFile:        c:\\users\\gfj138\\pycharmprojects\\piecash\\piecash\\scripts\\fire_test.py\r\nLine:        7\r\nDocstring:   Says count times the message to the specified name.\r\n\r\n:param name (str): the name of the person\r\n:param message (str): the message to say to the person\r\n:param count (int): the number of times the message should be repeated\r\n:return: the expected result\r\n\r\nUsage:       fire_test.py hello NAME [MESSAGE] [COUNT]\r\n             fire_test.py hello --name NAME [--message MESSAGE] [--count COUNT]\r\n```\r\nwhere:\r\n- the fire trace looks more like a \"debugging feature\" than a \"user feedback\"\r\n- the same for the Type/String form/File/Line information\r\n- the docstring is displayed as such which make it not user friendly\r\n- the default values of the optional arguments are not visible\r\n\r\nIs there some better way to document the commands and their arguments I may be missing ?\r\nAny good practice re documentation ?","author":{"url":"https://github.com/sdementen","@type":"Person","name":"sdementen"},"datePublished":"2018-02-01T13:26:57Z","url":"https://github.com/google/python-fire/issues/114"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:f90d1d08-9723-75e0-18f6-9cd3db6e1532
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idA36A:34D7A7:69BAE6:8E45FE:6B00391A
html-safe-nonce7cfb86514070379cd5d63dc6174f1c6ecca080e160a95068e12e55cf51d3865d
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMzZBOjM0RDdBNzo2OUJBRTY6OEU0NUZFOjZCMDAzOTFBIiwidmlzaXRvcl9pZCI6IjE3MDQ4OTMxNTgzNDI1Mzk1NDciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac2152af724ef0c5eec38320e430b4c98af4d2cae3e6156cab26aa3b532f97142d
hovercard-subject-tagissue:293529520
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/google/python-fire/114/issue_layout
twitter:imagehttps://opengraph.githubassets.com/8e39dd810b6bdd90b321fb4ab953dd53493e406ec3e53164f87e643deef86e2d/google/python-fire/issues/114
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/8e39dd810b6bdd90b321fb4ab953dd53493e406ec3e53164f87e643deef86e2d/google/python-fire/issues/114
og:image:altI have some questions/comments on the "user friendliness" of fire. With the following script fire_test.py import fire class Example(object): """this is an example module with some functions""" def ...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamesdementen
hostnamegithub.com
expected-hostnamegithub.com
None7d0829bbde9e48b2486cb5dd6d147896eb01d32134627091f818958a935ef3f0
turbo-cache-controlno-preview
go-importgithub.com/google/python-fire git https://github.com/google/python-fire.git
octolytics-dimension-user_id1342004
octolytics-dimension-user_logingoogle
octolytics-dimension-repository_id82729529
octolytics-dimension-repository_nwogoogle/python-fire
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id82729529
octolytics-dimension-repository_network_root_nwogoogle/python-fire
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
releasef3f3a43ca095cdea3abbb394112e971f9fdb94fa
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/google/python-fire/issues/114#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fgoogle%2Fpython-fire%2Fissues%2F114
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fgoogle%2Fpython-fire%2Fissues%2F114
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=google%2Fpython-fire
Reloadhttps://github.com/google/python-fire/issues/114
Reloadhttps://github.com/google/python-fire/issues/114
Reloadhttps://github.com/google/python-fire/issues/114
googlehttps://github.com/google
python-firehttps://github.com/google/python-fire
Codehttps://github.com/google/python-fire
Issues146 (146)https://github.com/google/python-fire/issues
Pull requests85 (85)https://github.com/google/python-fire/pulls
Actionshttps://github.com/google/python-fire/actions
Projectshttps://github.com/google/python-fire/projects
Security and qualityhttps://github.com/google/python-fire/security
Insightshttps://github.com/google/python-fire/insights
https://github.com/google/python-fire
New issuehttps://github.com/login?return_to=https://github.com/google/python-fire/issues/114
New issuehttps://github.com/login?return_to=https://github.com/google/python-fire/issues/114
documentation of commands/argumentshttps://github.com/google/python-fire/issues/114#top
https://github.com/sdementen
sdementenhttps://github.com/sdementen
on Feb 1, 2018https://github.com/google/python-fire/issues/114#issue-293529520
https://github.com/dbieber
dbieberhttps://github.com/dbieber
on Feb 1, 2018https://github.com/google/python-fire/issues/114#issuecomment-362405245
#26https://github.com/google/python-fire/issues/26
https://github.com/sdementen
sdementenhttps://github.com/sdementen
on Feb 1, 2018https://github.com/google/python-fire/issues/114#issuecomment-362409329
#26https://github.com/google/python-fire/issues/26
https://github.com/dbieber
dbieberhttps://github.com/dbieber
on Jul 25, 2019https://github.com/google/python-fire/issues/114#issuecomment-515233643
#184https://github.com/google/python-fire/issues/184
dbieberhttps://github.com/dbieber
completedhttps://github.com/google/python-fire/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Jul 25, 2019https://github.com/google/python-fire/issues/114#event-2510963761
https://github.com/david-macleod
david-macleodhttps://github.com/david-macleod
on Aug 5, 2019https://github.com/google/python-fire/issues/114#issuecomment-518144801
https://github.com/dbieber
dbieberhttps://github.com/dbieber
on Aug 5, 2019https://github.com/google/python-fire/issues/114#issuecomment-518270717
#184https://github.com/google/python-fire/issues/184
Sign up for freehttps://github.com/signup?return_to=https://github.com/google/python-fire/issues/114
Sign in to commenthttps://github.com/login?return_to=https://github.com/google/python-fire/issues/114
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.