[WIP] Documentation for all the standard rules

[pranaygp]

No description provided.

[todo]

This value cannot be used by browse and is only understood by the runtime. Provide a better value }

browse/packages/core/lib/std.js

Lines 325 to 329 in 39e47a3

	* @return { [Rule] TODO: This value cannot be used by browse and is only understood by the runtime. Provide a better value }
	* @throws { If a rule already exists with the same name }
	*/
	rule: (scope) => (opts) => (name, body) => {
	let existingRule;

---

This comment was generated by todo based on a TODO comment in 39e47a3 in #73. cc @windsorio.

[todo]

remove this check when we have static types

browse/packages/core/lib/std.js

Lines 347 to 352 in 39e47a3

	// TODO: remove this check when we have static types
	if (typeof ms !== "number") throw new Error("Argument is a not a number");
	return new Promise((r) => setTimeout(r, ms)).then(() => ms);
	},
	/**
	* @desc { Print values to stdout }

---

This comment was generated by todo based on a TODO comment in 39e47a3 in #73. cc @windsorio.

[todo]

) }

browse/packages/core/lib/std.js

Lines 647 to 652 in 39e47a3

	* @desc { Import a module. Read the [Browse Modules](#) guide for more info (TODO) }
	*/
	import: (_) => (_) => async (...mods) => {
	// evalRule should catch imports and handle them specially
	throw new Error("Unexpected browse error");
	},

---

This comment was generated by todo based on a TODO comment in 39e47a3 in #73. cc @windsorio.

[todo]

if body has `expects`, inject those from _ruleEvalScope

browse/packages/core/lib/std.js

Lines 611 to 616 in 447210d

	// TODO: if body has `expects`, inject those from _ruleEvalScope
	evalRuleSet(body, {
	rules: {
	// TODO: bind should only be accessible at the top level
	/**
	* @rule { bind }

---

This comment was generated by todo based on a TODO comment in 447210d in #73. cc @windsorio.

[todo]

Will break if multiple rules have the same name in different scopes

browse/packages/docs/plugins/markdownGen.js

Lines 39 to 44 in 447210d

	// TODO: Will break if multiple rules have the same name in different scopes
	const rules = Object.keys(docTree[scope].rules).map((rule) =>
	link(`Rule: ${rule}`, `#${rule}`)
	);
	const configVars = Object.keys(

---

This comment was generated by todo based on a TODO comment in 447210d in #73. cc @windsorio.

[todo]

bind should only be accessible at the top level

browse/packages/core/lib/std.js

Lines 614 to 619 in 447210d

	// TODO: bind should only be accessible at the top level
	/**
	* @rule { bind }
	* @scope { rule }
	* @desc {
	* **Only used within a {@link rule\} body**

---

This comment was generated by todo based on a TODO comment in 447210d in #73. cc @windsorio.

[todo]

if body has `expects`, inject those from _ruleEvalScope

browse/packages/core/lib/std.js

Lines 614 to 619 in aa53349

	// TODO: if body has `expects`, inject those from _ruleEvalScope
	evalRuleSet(body, {
	rules: {
	// TODO: bind should only be accessible at the top level
	/**
	* @rule { bind }

---

This comment was generated by todo based on a TODO comment in aa53349 in #73. cc @windsorio.

[todo]

if body has `expects`, inject those from _ruleEvalScope

browse/packages/core/lib/std.js

Lines 614 to 619 in e13c34f

	// TODO: if body has `expects`, inject those from _ruleEvalScope
	evalRuleSet(body, {
	rules: {
	// TODO: bind should only be accessible at the top level
	/**
	* @rule { bind }

---

This comment was generated by todo based on a TODO comment in e13c34f in #73. cc @windsorio.

[todo]

Should return the value of the last evaluated statement, or the number of iterations?)

browse/packages/docs/out.md

Lines 256 to 261 in e13c34f

	- Returns: \<**nil**\> nil (TODO: Should return the value of the last evaluated statement, or the number of iterations?)
	Execute the `body` while the `test` expressions in the `interator` do not fail
	> The contents of the iterator is split into multiple parts:
	>

---

This comment was generated by todo based on a TODO comment in e13c34f in #73. cc @windsorio.

[todo]

if body has `expects`, inject those from _ruleEvalScope

browse/packages/core/lib/std.js

Lines 614 to 619 in 0d87ce0

	// TODO: if body has `expects`, inject those from _ruleEvalScope
	evalRuleSet(body, {
	rules: {
	// TODO: bind should only be accessible at the top level
	/**
	* @rule { bind }

---

This comment was generated by todo based on a TODO comment in 0d87ce0 in #73. cc @windsorio.

[todo]

if body has `expects`, inject those from _ruleEvalScope

browse/packages/core/lib/std.js

Lines 614 to 619 in 60bb6f1

	// TODO: if body has `expects`, inject those from _ruleEvalScope
	evalRuleSet(body, {
	rules: {
	// TODO: bind should only be accessible at the top level
	/**
	* @rule { bind }

---

This comment was generated by todo based on a TODO comment in 60bb6f1 in #73. cc @windsorio.

[todo]

if body has `expects`, inject those from _ruleEvalScope

browse/packages/core/lib/std.js

Lines 614 to 619 in 6d0c850

	// TODO: if body has `expects`, inject those from _ruleEvalScope
	evalRuleSet(body, {
	rules: {
	// TODO: bind should only be accessible at the top level
	/**
	* @rule { bind }

---

This comment was generated by todo based on a TODO comment in 6d0c850 in #73. cc @windsorio.

[todo]

Only pull from comments that start with *

browse/packages/docs/parsers/js.js

Lines 60 to 65 in 6d0c850

	* TODO: Only pull from comments that start with *
	*/
	const pullAllTags = (comments) =>
	comments.map((comment) => pullTags(comment.value)).reduce(safeMergeObjs, {});
	const parseParams = (paramString) => {

---

This comment was generated by todo based on a TODO comment in 6d0c850 in #73. cc @windsorio.

[todo]

Return just the comments not within a tag

browse/packages/docs/parsers/js.js

Lines 119 to 124 in 6d0c850

	//TODO: Return just the comments not within a tag
	rtn.help = rule.leadingComments
	.map((node) => cleanComment(node.value))
	.join("\n");
	} else {
	//else we just extract data from @help tags

---

This comment was generated by todo based on a TODO comment in 6d0c850 in #73. cc @windsorio.

[todo]

Return just the comments not within a tag

browse/packages/docs/parsers/js.js

Lines 131 to 136 in 6d0c850

	//TODO: Return just the comments not within a tag
	rtn.help = rule.leadingComments
	.map((node) => cleanComment(node.value))
	.join("\n");
	} else {
	//else we just extract data from @help tags

---

This comment was generated by todo based on a TODO comment in 6d0c850 in #73. cc @windsorio.

[todo]

Return just the comments not within a tag

browse/packages/docs/parsers/js.js

Lines 195 to 200 in 6d0c850

	//TODO: Return just the comments not within a tag
	rtn[ruleName].help = rule.leadingComments
	.map((node) => cleanComment(node.value))
	.join("\n");
	} else {
	//else we just extract data from @help tags

---

This comment was generated by todo based on a TODO comment in 6d0c850 in #73. cc @windsorio.

[todo]

Return just the comments not within a tag

browse/packages/docs/parsers/js.js

Lines 207 to 212 in 6d0c850

	//TODO: Return just the comments not within a tag
	rtn[ruleName].help = rule.leadingComments
	.map((node) => cleanComment(node.value))
	.join("\n");
	} else {
	//else we just extract data from @help tags

---

This comment was generated by todo based on a TODO comment in 6d0c850 in #73. cc @windsorio.

[todo]

We should try to grab the name, type, and init value

browse/packages/docs/parsers/js.js

Lines 247 to 252 in 6d0c850

	//TODO: We should try to grab the name, type, and init value
	const propertyName = property.key.name;
	const tags = pullAllTags(property.leadingComments || []);
	if (tags["@config"] === undefined) {

---

This comment was generated by todo based on a TODO comment in 6d0c850 in #73. cc @windsorio.

[pranaygp]

The docs generator for .browse files isn't done but, I'm merging this in now because it's submission day.

After everything is tested, I'll finish the doc generator #78