ruby-jss icon indicating copy to clipboard operation
ruby-jss copied to clipboard

YARD Documentation Enhancement

Open cybertunnel opened this issue 4 years ago • 1 comments

Fixed a few YARD document parsing issues discovered which includes the JSS::DirectoryBinding and JSS::DirectoryBindingType and children objects.

cybertunnel avatar Sep 03 '20 19:09 cybertunnel

Hi hi

This branch is showing conflicts outside of just YARD docs:

            # Set specific groups to become administrators to a system.
            # 
            # @author Tyler Morgan
            #
            # @param newvalue [Array<String>] An array of all the admin group names you want to set.
            # @see add_admin_group
            # @see remove_admin_group
            #
            # @raise [JSS::InvalidDataError] If the new value is not an Array
            #
            # @return [void]
<<<<<<< develop
            def admin_groups=(newvalue)
                
                raise JSS::InvalidDataError, "An Array must be provided, please use add_admin_group and remove_admin_group for individual group additions and removals." unless newvalue.is_a? Array
=======
            def admin_group=(newvalue)
>>>>>>> master

                new =
                    if newvalue.to_s.empty?
                        JSS::BLANK
                    else
                        # Data Check
                        raise JSS::InvalidDataError, "An Array must be provided, please use add_admin_group and remove_admin_group for individual group additions and removals." unless newvalue.is_a? Array
                        newvalue
                    end

                @admin_group = new
                
                self.container&.should_update
            end

I'm not sure which way you want to name and validate that method, so let me know which is preferred. Thanks!

glenfarclas17 avatar Nov 09 '20 23:11 glenfarclas17