Skip to content
This repository has been archived by the owner on Dec 18, 2018. It is now read-only.

Add some documentation for public types and methods #120

Closed
victorhurdugaci opened this issue Oct 30, 2014 · 4 comments
Closed

Add some documentation for public types and methods #120

victorhurdugaci opened this issue Oct 30, 2014 · 4 comments
Assignees
Milestone

Comments

@victorhurdugaci
Copy link
Contributor

The packages here are totally missing documentation and it is not obvious, without looking at the code, how are they supposed to be used.

For example, is I have:

Configuration config = new Configuration();
config.AddCommandLine(args);

What is the format accepted by the strings in "args" to be valid? There are many possible options: /key value, --key value, --key:value, key=value, etc.

@muratg muratg added this to the 1.0.0-rc1 milestone Feb 20, 2015
@muratg muratg added polish and removed enhancement labels Feb 20, 2015
@muratg muratg modified the milestones: 1.0.0-beta5, 1.0.0-beta4 Mar 20, 2015
@Eilon Eilon assigned Eilon and unassigned ChengTian May 13, 2015
@danroth27 danroth27 modified the milestone: 1.0.0-beta5 Jun 29, 2015
@HaoK HaoK assigned kirthik and unassigned Eilon Sep 30, 2015
@HaoK HaoK added this to the 1.0.0-rc1 milestone Sep 30, 2015
@divega divega modified the milestones: 1.0.0-rc2, 1.0.0-rc1 Nov 23, 2015
@divega divega assigned HaoK and unassigned kirthik Nov 23, 2015
@HaoK
Copy link
Member

HaoK commented Jan 14, 2016

Not going to get to this for rc2, clearing for retriage...

@HaoK HaoK removed this from the 1.0.0-rc2 milestone Jan 14, 2016
@HaoK HaoK removed their assignment Jan 14, 2016
@HaoK HaoK assigned HaoK and shirhatti and unassigned HaoK Mar 30, 2016
@HaoK
Copy link
Member

HaoK commented Mar 30, 2016

Can you take a look and add documentation if we are still missing any?

@HaoK HaoK added this to the 1.0.0-rc2 milestone Mar 30, 2016
@divega divega modified the milestones: 1.0.0, 1.0.0-rc2 Apr 1, 2016
@HaoK
Copy link
Member

HaoK commented Jun 13, 2016

e1b7960

@divega
Copy link

divega commented Jun 13, 2016

Filed dotnet/AspNetCore.Docs#1382 to track adding command line argument formats supported in documentation.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

9 participants