Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add functionSignatures.json #38

Merged
merged 1 commit into from
May 21, 2024
Merged

Add functionSignatures.json #38

merged 1 commit into from
May 21, 2024

Conversation

ccreutzi
Copy link
Member

Cf. MATLAB documentation for details about the file format.

JSON unfortunately does not allow comments. Some of the "type" definitions in the file do not match accepted values exactly: I have not listed that several name value pairs accept empties, and have not found a good way to say that StopSequences can have at most four entries. Nothing in here removes the existing input validations.

Cf. https://www.mathworks.com/help/matlab/matlab_prog/customize-code-suggestions-and-completions.html
for details about the file format.

JSON unfortunately does not allow comments. Some of the "type" definitions in
the file do not match accepted values exactly: I have not listed that several
name value pairs accept empties, and have not found a good way to say that
StopSequences can have at most four entries. Nothing in here removes the
existing input validations.
@ccreutzi ccreutzi self-assigned this May 21, 2024
@ccreutzi
Copy link
Member Author

Here's the reported test failure:

  ================================================================================
  Error occurred in texampleTests/testRetrievalAugmentedGenerationUsingChatGPTandMATLAB and it did not run to completion.
      ---------
      Error ID:
      ---------
      'MATLAB:webservices:Timeout'
      --------------
      Error Details:
      --------------
      Error using websave (line 98)
      The connection to URL
      'https://openknowledge.worldbank.org/bitstreams/0c18c872-91f0-51a4-ba91-c36b98893b4a/download'
      timed out after 5.000 seconds. The reason is "Waiting for response header".
      Perhaps the server is not responding or weboptions.Timeout needs to be set
      to a
      higher value.
      
      Error in RetrievalAugmentedGenerationUsingChatGPTandMATLAB (line 14)
          websave(local_file_name, url{i});
      
      Error in texampleTests/testRetrievalAugmentedGenerationUsingChatGPTandMATLAB
      (line 54)
                  RetrievalAugmentedGenerationUsingChatGPTandMATLAB;
  ================================================================================

I don't like that we have tests relying on external servers. And I am going to ignore this test failure here – changing functionSignatures.json should not be able to cause a remote server running into a timeout.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.72%. Comparing base (1365049) to head (3d8794d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #38   +/-   ##
=======================================
  Coverage   56.72%   56.72%           
=======================================
  Files          33       33           
  Lines        2015     2015           
=======================================
  Hits         1143     1143           
  Misses        872      872           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ccreutzi ccreutzi merged commit 05ac9a9 into main May 21, 2024
1 check passed
@ccreutzi ccreutzi deleted the functionSignatures branch May 21, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants