Skip to content

Conversation

@dacharyc
Copy link
Contributor

@dacharyc dacharyc commented Oct 17, 2024

  • Still need to add support for:
    • [ ] Ruby block comments: https://docs.ruby-lang.org/en/master/syntax/comments_rdoc.html After speaking with Kay, that comment syntax is mainly used for doc comments and we don't need to support it for Bluehawk purposes
    • Decide whether/how to support both PHP comment syntax (// and #)
    • [ ] ipynb - is this possible? : ipynb isn't just text - I don't think we can use Bluehawk to work with it

Jira ticket link: DOCSP-44543

Content of ticket, since this is an open source tool that theoretically anyone could use...

Bluehawk does not currently support parsing files in all of the Drivers language types.

Add support to the rstLanguageMap for missing Drivers programming languages:

  • C
  • Go
  • PHP
  • Python
  • Ruby
  • Rust
  • Scala

Add tests for files in each language.

Confirm our handling of comment syntax covers all of these languages, or put in separate tickets to update Bluehawk to accommodate anything that's not supported.

As a stretch goal, support .ipynb files so we can use Bluehawk to copy Jupyter notebooks between repos.

@dacharyc dacharyc merged commit 6c5f261 into mongodb-university:main Oct 18, 2024
2 checks passed
@dacharyc dacharyc deleted the DOCSP-44543 branch October 18, 2024 15:06
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.

2 participants