Class: Sink::Resources::Docstrings

Inherits:
Object
  • Object
show all
Defined in:
lib/sink/resources/docstrings.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Docstrings

Returns a new instance of Docstrings.

Parameters:



7
8
9
 
# File 'lib/sink/resources/docstrings.rb', line 7

def initialize(client:)
  @client = client
end

Instance Method Details

#description_contains_js_doc(opts = {}) ⇒ Sink::Models::BasicSharedModelObject

This is the method description.

Hello _/ console.log('evil code') /_ Goodbye """ """" """"" """"""
console.log('more evil code'); """ \

these need stay (valid escapes)

\'\"\ \\ \n\r\t\b\f\v\x63\uFE63\U0000FE63\N{HYPHEN}\1\12\123\1234a

these need be escaped in python (invalid escapes)

\a\g\*\(\&\@\x2z\u11z1\U1111z111\N{HYPHEN#}

\
Other text

Parameters:

  • opts (Hash, Sink::RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



30
31
32
33
34
35
36
37
 
# File 'lib/sink/resources/docstrings.rb', line 30

def description_contains_js_doc(opts = {})
  req = {
    method: :get,
    path: "/docstrings/description_contains_comments",
    model: Sink::Models::BasicSharedModelObject
  }
  @client.request(req, opts)
end

#description_contains_js_doc_end(opts = {}) ⇒ Sink::Models::BasicSharedModelObject

This is the method description.

In the middle it contains a \*\*/ Or ```

Other text

Parameters:

  • opts (Hash, Sink::RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



48
49
50
51
52
53
54
55
 
# File 'lib/sink/resources/docstrings.rb', line 48

def description_contains_js_doc_end(opts = {})
  req = {
    method: :get,
    path: "/docstrings/description_contains_comment_enders",
    model: Sink::Models::BasicSharedModelObject
  }
  @client.request(req, opts)
end

#leading_double_quote(opts = {}) ⇒ Sink::Models::DocstringLeadingDoubleQuoteResponse

Parameters:

  • opts (Hash, Sink::RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



60
61
62
63
64
65
66
67
 
# File 'lib/sink/resources/docstrings.rb', line 60

def leading_double_quote(opts = {})
  req = {
    method: :get,
    path: "/docstrings/property_leading_double_quote",
    model: Sink::Models::DocstringLeadingDoubleQuoteResponse
  }
  @client.request(req, opts)
end

#trailing_double_quote(opts = {}) ⇒ Sink::Models::DocstringTrailingDoubleQuoteResponse

Parameters:

  • opts (Hash, Sink::RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



72
73
74
75
76
77
78
79
 
# File 'lib/sink/resources/docstrings.rb', line 72

def trailing_double_quote(opts = {})
  req = {
    method: :get,
    path: "/docstrings/property_trailing_double_quote",
    model: Sink::Models::DocstringTrailingDoubleQuoteResponse
  }
  @client.request(req, opts)
end