Skip to content

docs: paper #111

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

docs: paper #111

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
06af3bd
docs: first paper draft
cmeesters Apr 7, 2025
fc60051
docs: first round with hopefully working bibliography
cmeesters Apr 8, 2025
f129380
docs: added github action to typeset draft
cmeesters Apr 8, 2025
37dc5bc
fix: corrected metadata section
cmeesters Apr 8, 2025
034c11a
fix: syntax
cmeesters Apr 8, 2025
ee3886f
fix: syntax
cmeesters Apr 8, 2025
db39ed1
Update paper/paper.md
cmeesters Apr 8, 2025
7687119
fix: upload path
cmeesters Apr 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/draft-pdf.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Draft PDF
on:
push:
paths:
- paper/**
- .github/workflows/draft-pdf.yml

jobs:
paper:
runs-on: ubuntu-latest
name: Paper Draft
steps:
Comment on lines +8 to +12
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Jobs Block: Correct Indentation

The jobs section also shows inconsistent indentation. For instance, line 9 (the key paper:) is indented with 2 spaces while the expected indentation is 4, and line 10’s runs-on: ubuntu-latest should be indented by 6 spaces rather than 4.

A consistent reindentation might look like this:



Adjust the rest of the document similarly to maintain uniformity.




Committable suggestion skipped: line range outside the PR's diff.





🧰 Tools


🪛 YAMLlint (1.35.1)

[warning] 9-9: wrong indentation: expected 4 but found 2


(indentation)




[warning] 10-10: wrong indentation: expected 6 but found 4


(indentation)






    

  
  



    


        

      
  
  

    
  
    
    

  

  

  



          

      
    








    


  









  


    


  		



    

    

    

  
          - name: Checkout






    

    

    

  
            uses: actions/checkout@v4






    

    

    

  
          - name: Build draft PDF






    

    

    

  
            uses: openjournals/openjournals-draft-action@master






    

    

    

  
            with:






    

    

    

  
              journal: joss






    

    

    

  
              # This should be the path to the paper within your repo.






    

    

    

  
              paper-path: paper/paper.md






    

    

    

  
          - name: Upload






    

    

    

  
            uses: actions/upload-artifact@v4






    

    

    

  
            with:






    

    

    

  
              name: paper






    

    

    

  
              # This is the output path where Pandoc will write the compiled






    

    

    

  
              # PDF. Note, this should be the same directory as the input






    

    

    

  
              # paper.md






      


  
        

      
  
    
    

      
      
          



  

    

        

        

  

    

        
    
    

  


      
          
  
      
            Copy link

  

      
    

  


  

      

  
    Contributor


      

  


  

    

  




        

      

  

  
 

  
    

    
Choose a reason for hiding this comment


    

      The reason will be displayed to describe this comment to others. Learn more.
    


    

      
      



  



  
    

      
🛠️ Refactor suggestion


Steps Block: Reindent Step Items and Parameters


Several steps within the job have indentation issues as well. Static analysis reports that:


    

  • Line 13 (“- name: Checkout”) is indented with 6 spaces instead of the expected 8.
    • 

  • Line 18 (the “journal: joss” key) is indented with 10 spaces when 12 are expected.
    • 

  • Line 24 (“name: paper”) similarly shows too few spaces.
    • 



A suggested reindentation for the steps block using a 2-space-per-level standard is:




This will help clear the YAML lint warnings and ensure that the workflow is parsed correctly.




Committable suggestion skipped: line range outside the PR's diff.





🧰 Tools


🪛 YAMLlint (1.35.1)

[warning] 13-13: wrong indentation: expected 8 but found 6


(indentation)




[warning] 18-18: wrong indentation: expected 12 but found 10


(indentation)




[warning] 24-24: wrong indentation: expected 12 but found 10


(indentation)






    

  
  



    


        

      
  
  

    
  
    
    

  

  

  



          

      
    








    


  









  


    


  		



    

    

    

  
              path: paper.pdf
      
        
    

      
    








                
              


          


    

  



  


    

  
  
    
      Loading