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

Question: might we rename the Try OCaml button in Learn-OCaml's homepage? #415

Closed
erikmd opened this issue Sep 1, 2021 · 4 comments · Fixed by #451
Closed

Question: might we rename the Try OCaml button in Learn-OCaml's homepage? #415

erikmd opened this issue Sep 1, 2021 · 4 comments · Fixed by #451
Assignees

Comments

@erikmd
Copy link
Member

erikmd commented Sep 1, 2021

Hi all,

This is definitely not an urgent question, but I'm opening this issue to get more feedback:

currently (if most learn-ocaml features are enabled), we have the following buttons in the homepage:

2021-09-01_Screenshot_Learn-OCaml_Home

I see one potential issue with the first button Try OCaml:

  • many users or students are familiar with the Try OCaml webapp and understand this term as an online toplevel,
  • but this button actually redirects to the tutorials feature of Learn-OCaml, which can precisely be customized within the repository/tutorials/ folder.

See e.g. the output of learn-ocaml build --help:

       --enable-tryocaml
           Enable the 'TryOCaml' tab (enabled by default if the repository
           contains a tutorials directory)
  • On the other hand, the name of the Toplevel button and that of the Playground button (text-editor + toplevel) look fine.

Hence the questions

  1. Would you agree to rename this button? if yes:
    A. to Tutorials?
    B. to OCaml Tutorials?
    C. to another thing?

  2. If we rename the button, should we also rename the option --enable-tryocaml to --enable-tutorials?

But actually I guess the answer to 2. should probably be no, for CLI backward-compatibility…

@erikmd
Copy link
Member Author

erikmd commented Sep 15, 2021

Hi all (@AltGr @gasche @yurug @EmileRolley @hannelita @asere @lsylvestre and all the Watchers of this learn-ocaml repo :)

I know that this question is not critical at all; but if there is some consensus, we may want to include this small change for the upcoming learn-ocaml 0.13 as well (so feel free to react if you have an opinion on my 2 questions above 🙂)

@gasche
Copy link
Contributor

gasche commented Sep 15, 2021

No strong opinion, but I would find "tutorials" appropriate. You could add --enable-tutorials as a new option, and keep --enable-tryocaml for backward-compatibility.

@hannelita
Copy link

+1 for "Tutorials"

@erikmd
Copy link
Member Author

erikmd commented Oct 4, 2021

Regarding this small question, thanks a lot for your feedback! no objection was raised, so +1 for @gasche's suggestion.

I'll open a PR but let's postpone this to learn-ocaml 0.14 (as it's not a critical User Story to appear in the pending 0.13 AFAICT).

@erikmd erikmd self-assigned this Oct 4, 2021
@erikmd erikmd added this to the learn-ocaml 0.14.0 milestone Oct 4, 2021
erikmd added a commit to pfitaxel/learn-ocaml that referenced this issue Nov 1, 2021
* Rename all relevant identifiers in the code, to avoid any ambiguity;

* learnocaml_main.ml: Keep CLI opt --enable-tryocaml for backward-compatibility

Close ocaml-sf#415
erikmd added a commit to pfitaxel/learn-ocaml that referenced this issue Nov 1, 2021
* Rename all relevant identifiers in the code, to avoid any ambiguity;

* learnocaml_main.ml: Keep CLI option --enable-tryocaml for
  backward-compatibility; Use a dedicated list of old option names

Close ocaml-sf#415
erikmd added a commit to pfitaxel/learn-ocaml that referenced this issue Jan 7, 2022
* Rename all relevant identifiers in the code, to avoid any ambiguity;

* learnocaml_main.ml: Keep CLI option --enable-tryocaml for
  backward-compatibility; Use a dedicated list of old option names

Close ocaml-sf#415
erikmd added a commit to pfitaxel/learn-ocaml that referenced this issue Jan 7, 2022
* Rename all relevant identifiers in the code, to avoid any ambiguity;

* learnocaml_main.ml: Keep CLI option --enable-tryocaml for
  backward-compatibility; Use a dedicated list of old option names

Close ocaml-sf#415
yurug pushed a commit that referenced this issue Feb 25, 2022
#451)

* Rename all relevant identifiers in the code, to avoid any ambiguity;

* learnocaml_main.ml: Keep CLI option --enable-tryocaml for
  backward-compatibility; Use a dedicated list of old option names

Close #415
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants