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.

Sign up for GitHub

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

Jump to bottom

Fix the docs in pybamm.FuzzyDict class #4845

Open
Akhil-Sharma30 opened this issue Feb 13, 2025 · 1 comment · May be fixed by #4846
Open

Fix the docs in pybamm.FuzzyDict class #4845

Akhil-Sharma30 opened this issue Feb 13, 2025 · 1 comment · May be fixed by #4846

Comments

@Akhil-Sharma30
Copy link
Contributor

PyBaMM Version

Latest

Python Version

python 3.11

Describe the bug

Took #3392 , This is a part of API Docs in this issue includes:

  • pybamm.FuzzyDict.copy. needs docstring
  • pybamm.FuzzyDict. get_best_matches. document key arg
  • pybamm.FuzzyDict. search. document args. format code properly

Steps to Reproduce

Not applicable

Relevant log output


      		
    

      
  





        



            

              
            

        

      


      
    








      

    



      

  
            

    

      
    

    


      

          @Akhil-Sharma30
Akhil-Sharma30




          added
  the 

  bug

  Something isn't working
 label


      Feb 13, 2025

    

  



    

    

      
    

    


      

          @Akhil-Sharma30
Akhil-Sharma30




        changed the title
[Bug]:

[Bug]: Fix the Bug in pybamm.FuzzyDict class


      Feb 13, 2025

    

  



  

  

    
  


  

      

    @Akhil-Sharma30
Akhil-Sharma30



    linked a pull request
    
      Feb 13, 2025
    

    that will
    close
    this issue





  


  

      
   Draft

  







  




    

    

      
    

    


      

          @kratman
kratman




          removed
  the 

  bug

  Something isn't working
 label


      Feb 14, 2025

    

  



    

    

      
    

    


      

          @kratman
kratman




        changed the title
[Bug]: Fix the Bug in pybamm.FuzzyDict class

Fix the Bug in pybamm.FuzzyDict class


      Feb 14, 2025

    

  








      

  
      



  

  @kratman





  


    

      

  

    

        
    
    

  


      
          
  
      
            Copy link

  

      
    

  


  

      

  
    Contributor


      

  


  

    

      

      
            kratman
  

      

      

      commented


        Feb 14, 2025


      
    


  





      


        


  
    

      
          
Not really a bug, so changed the title

      		
    

  





        


            

            

              
            

        

      


      

            
  

    
  
    
    

  

  



    












      

  
            

    

      
    

    


      

          @kratman
kratman




        changed the title
Fix the Bug in pybamm.FuzzyDict class

Fix the docs in pybamm.FuzzyDict class


      Feb 14, 2025

    

  












  
  

    

      

  





  




  
  

              

  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment


  



  






  
                  




    

  


      
  

    Assignees
  



        

    No one assigned







      


  


  

    Labels
  



    

    None yet







      

  

    

        

    Projects
  


        




    None yet




  



      


  

    
  

    Milestone
  


      No milestone





    
      
          
  

    

      

        
          

            
    

    Development
  




              
  
Successfully merging a pull request may close this issue.





    


  
          
      Add Fuzzydict docstring

    
      Akhil-Sharma30/PyBaMM
    





        
      

    

  


      

    

  
      

  

    

      2 participants
    

    

        
          @kratman 
        
          @Akhil-Sharma30