add phpdoc for function

eventespresso · Apr 30, 2018 · 793503c · 793503c
1 parent f895c28
commit 793503c
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/assets/src/components/selection/event-select/build-event-options.js b/assets/src/components/selection/event-select/build-event-options.js
@@ -3,6 +3,14 @@
  */
 import { reduce } from 'lodash';
 
+/**
+ * Receives an array of event entities and returns an array of simple objects
+ * that can be passed along to the options array used for the WordPress
+ * SelectControl component.
+ *
+ * @param { Array } events
+ * @return { Array }
+ */
 export const buildEventOptions = ( events ) => {
 	return reduce( events, function( options, event ) {
 		options.push(