Add docstrings for version service

[pr7prashant]

• Added docstrings for version service

[github-actions]

	Messages
📖	✨ Thanks for your contribution to Shields, @pr7prashant!

Generated by 🚫 dangerJS against 0f1c69a

[chris48s]

thanks for picking this up

[chris48s]

When does this return null? I'd have thought an invalid semver range would throw TypeError: Invalid SemVer Range when we try to construct it.

[chris48s]

this one is still outstanding

[pr7prashant]

done

[pr7prashant]

updated

[pr7prashant]

Hey @chris48s, I've made all the suggested changes but I couldn't get the backticks to render as <code></code> in the docs so I used @example tag instead to make the code more discrete.

[chris48s]

Cheers. There's one still to follow up on, I think: #9411 (comment)

I've made all the suggested changes but I couldn't get the backticks to render as in the docs so I used @example tag instead to make the code more discrete.

Using @example works fine 👍 but here's a working example using backticks and the rendered output:

• shields/core/base-service/openapi.js

  Lines 357 to 380 in 7d966ab

  	/**
  	* Helper function for assembling an array of OpenAPI path parameter objects
  	* The code
  	* ```
  	* const params = pathParams(
  	* { name: 'name1', example: 'example1' },
  	* { name: 'name2', example: 'example2' },
  	* )
  	* ```
  	* is equivilent to
  	* ```
  	* const params = [
  	* pathParam({ name: 'name1', example: 'example1' }),
  	* pathParam({ name: 'name2', example: 'example2' }),
  	* ]
  	* ```
  	*
  	* @param {...module:core/base-service/openapi~PathParamInput} params Input params
  	* @returns {Array.<module:core/base-service/openapi~OpenApiParam>} Array of OpenAPI Parameter Objects
  	* @see {@link module:core/base-service/openapi~pathParam}
  	*/
  	function pathParams(...params) {
  	return params.map(param => pathParam(param))
  	}

• http://contributing.shields.io/module-core_base-service_openapi.html#~pathParams

[pr7prashant]

Oh my bad, I was using single backtick. It renders a code block in description but this does not render code block inside the @example tag. I hope the @example tag is fine. Please let me know if we need to change.

Here is an example how it looks in description vs @example with backticks:

[chris48s]

yep - no worries. I think the way you've done with @example is fine. Thanks