diff --git a/.rubocop.yml b/.rubocop.yml index 3cb19f0a..6dbfa8bf 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -10,7 +10,7 @@ AllCops: SuggestExtensions: false TargetRubyVersion: 3.1.0 -# Whether MFA is required or not should be left to the token configuration +# Whether MFA is required or not should be left to the token configuration. Gemspec/RequireMFA: Enabled: false @@ -72,6 +72,10 @@ Lint/EmptyInPattern: Exclude: - "test/**/*" +Lint/MissingCopEnableDirective: + Exclude: + - "examples/**/*.rb" + Lint/MissingSuper: Exclude: - "**/*.rbi" @@ -237,3 +241,8 @@ Style/StringLiterals: # Prefer explicit symbols for clarity; you can search for `:the_symbol`. Style/SymbolArray: EnforcedStyle: brackets + +# This option makes examples harder to read for ruby novices. +Style/SymbolProc: + Exclude: + - "examples/**/*.rb" diff --git a/.solargraph.yml b/.solargraph.yml index 98397e75..4f571833 100644 --- a/.solargraph.yml +++ b/.solargraph.yml @@ -2,8 +2,9 @@ max_files: 0 include: - '*.gemspec' - - '/test/openai/test_helper.rb' - 'Rakefile' + - 'examples/**/*.rb' - 'lib/**/*.rb' + - 'test/openai/test_helper.rb' exclude: - 'rbi/**/*' diff --git a/examples/.keep b/examples/.keep new file mode 100644 index 00000000..d8c73e93 --- /dev/null +++ b/examples/.keep @@ -0,0 +1,4 @@ +File generated from our OpenAPI spec by Stainless. + +This directory can be used to store example files demonstrating usage of this SDK. +It is ignored by Stainless code generation and its content (other than this keep file) won't be touched. \ No newline at end of file