Skip to content

Finish case scenarios + new devcontainer extension#14

Merged
kescobo merged 2 commits intomainfrom
case_scenario
Feb 10, 2025
Merged

Finish case scenarios + new devcontainer extension#14
kescobo merged 2 commits intomainfrom
case_scenario

Conversation

@M-PERSIC
Copy link
Member

@M-PERSIC M-PERSIC commented Sep 30, 2023

  • Finish the industry case scenario
  • Finish tool installation guide
  • Add Rewrap to standardize markdown
  • Fix typos

- Finish the industry case scenario
- Add Rewrap to standardize markdown
- Fix typos
@M-PERSIC M-PERSIC marked this pull request as ready for review September 30, 2023 00:32
@M-PERSIC
Copy link
Member Author

M-PERSIC commented Nov 9, 2023

@kescobo

@kescobo
Copy link
Member

kescobo commented Nov 15, 2023

I know I still owe you this review, sorry for the delay! It's on my list

Copy link
Member

Choose a reason for hiding this comment

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

This idea of a case scenario is not something I've noticed before. Is there a place that you're getting inspiration from?

Copy link
Member Author

Choose a reason for hiding this comment

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

Some if is based on my own internship experience + experiences shared with me via Slack + some inspiration from JuliaHub case studies :)

alone can almost be considered a proper IDE. It should appear the moment you enter `julia` into your terminal:
The Julia REPL is included by default in every Julia installation and boasts a
number of features to the point that it alone can almost be considered a proper
IDE. It should appear the moment you enter `julia` into your terminal:
Copy link
Member

Choose a reason for hiding this comment

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

Are we recommending people install julia via juliaup? I'm not sure how accessible the idea of a terminal is to windows users in particular, and I don't know how juliaup handles this on windows if installed through the app store. May be worth confirming.

itself is running from a terminal!)
5. Search modes (forward, reverse) to look through your history of inputs

| Prompt | Key binding |
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if it's worth mentioning how to get out of these modes, the fact that Pkg / Shell are sticky, etc

[Revise](https://timholy.github.io/Revise.jl/stable/) package, although restarting the session is the simplest option.
* You can run a standalone script by entering `include("<name of script>")` in
Julian mode. For greater control, the equivalent of Python3's `if __name__ ==
__main__` condition would be `if abspath(<name of program file>) == @__FILE__`
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we want to recommend this. It's not idiomatic to have a file that's used as both a script and a library like it is in python

One common gotcha with the Julia REPL is that there are currently certain code changes that cannot be performed without
restarting your session, such as redefining structs (see the example below). You can mitigate this by adding the
[Revise](https://timholy.github.io/Revise.jl/stable/) package, although restarting the session is the simplest option.
* You can run a standalone script by entering `include("<name of script>")` in
Copy link
Member

Choose a reason for hiding this comment

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

Mmm, I don't know if I would put it this way. Technically true, but really this is just evaluating the contents of another file. So for example any variables / functions that are defined will persist in your current session.

certain code changes that cannot be performed without restarting your
session, such as redefining structs (see the example below). You can
mitigate this by adding the
[Revise](https://timholy.github.io/Revise.jl/stable/) package, although
Copy link
Member

Choose a reason for hiding this comment

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

This phrasing is a bit misleading - Revise doesn't help with redefining structs...

Copy link
Member

Choose a reason for hiding this comment

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

This is still in progress?

Copy link
Member Author

Choose a reason for hiding this comment

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

I won't add anything more to this PR as it's already pretty big. I think 2-3 more big PRs and the MVP for BioJuliaDocs will be ready! I will review the changes this weekend and ping you for any further feedback

Copy link
Member

@kescobo kescobo Nov 20, 2023

Choose a reason for hiding this comment

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

OK, maybe Just add a couple of WIP flags on that page so it doesn't look like you forgot about it 😉

@M-PERSIC M-PERSIC marked this pull request as draft November 20, 2023 18:08
Copy link
Member

@kescobo kescobo left a comment

Choose a reason for hiding this comment

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

@M-PERSIC Any objection to me merging this? I know some stuff was still in-process, but we're planning to shift to have this be the main landing page of biojulia.dev rather than the franklin site we have currently.

CC @jakobnissen

@jakobnissen
Copy link
Member

Sounds good to me. @kescobo have you tried building this locally to verify it works? If so, I think we should just merge it.

@M-PERSIC
Copy link
Member Author

@kescobo no objections

@M-PERSIC M-PERSIC marked this pull request as ready for review January 23, 2025 17:34
@kescobo kescobo merged commit a58098c into main Feb 10, 2025
@kescobo kescobo deleted the case_scenario branch February 10, 2025 15:14
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