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

Line editing for Pointers #1112

Merged
merged 3 commits into from
Apr 24, 2023
Merged

Line editing for Pointers #1112

merged 3 commits into from
Apr 24, 2023

Conversation

christinerose
Copy link
Collaborator

No description provided.

christinerose and others added 2 commits April 19, 2023 12:40
Co-authored-by: sabine <sabine@users.noreply.github.com>
Co-authored-by: sabine <sabine@users.noreply.github.com>
@christinerose
Copy link
Collaborator Author

Excellent suggestions, @sabine! I've committed them to the file.

@christinerose
Copy link
Collaborator Author

Great! Now that you both have looked over it, is it ready to merge? (@cuihtlauac & @sabine)

@sabine
Copy link
Collaborator

sabine commented Apr 24, 2023

Yes, we can merge that, but reading the overall tutorial, I think this requires some deeper editing and restructuring than just line editing. It's the same situation as we have in many of the other tutorials.

@sabine sabine merged commit 8c807bc into ocaml:main Apr 24, 2023
@christinerose
Copy link
Collaborator Author

Good to know @sabine. What can I do to help with that?

@christinerose christinerose deleted the edit_pointers branch April 24, 2023 20:27
@sabine
Copy link
Collaborator

sabine commented Apr 25, 2023

The main problem with these tutorials is that they target a very specific kind of user - and there is no consistency on the previous knowledge the tutorials require.

In this tutorial, the targeted user is apparently someone who knows pointers because they know the C programming language.

@christinerose
Copy link
Collaborator Author

christinerose commented Apr 26, 2023

The main problem with these tutorials is that they target a very specific kind of user - and there is no consistency on the previous knowledge the tutorials require.

In this tutorial, the targeted user is apparently someone who knows pointers because they know the C programming language.

Do you have some suggestions on how to make it more consistent? I would be more than happy to work on that.

Also, would it be helpful to write an introduction to Pointers?

@cuihtlauac
Copy link
Collaborator

The main problem with these tutorials is that they target a very specific kind of user - and there is no consistency on the previous knowledge the tutorials require.

In this tutorial, the targeted user is apparently someone who knows pointers because they know the C programming language.

This tutorial needs a serious rewrite. I don't even think using the term “pointer” makes any sense at all in the context of OCaml. However, this is not a rewrite likely to happen in a short time. In the meantime, it's always better to improve what's possible, that will always be helpful for a more in-depth rewrite.

@christinerose
Copy link
Collaborator Author

The main problem with these tutorials is that they target a very specific kind of user - and there is no consistency on the previous knowledge the tutorials require.
In this tutorial, the targeted user is apparently someone who knows pointers because they know the C programming language.

This tutorial needs a serious rewrite. I don't even think using the term “pointer” makes any sense at all in the context of OCaml. However, this is not a rewrite likely to happen in a short time. In the meantime, it's always better to improve what's possible, that will always be helpful for a more in-depth rewrite.

Agreed. It's good to start somewhere, and we can keep improving iteratively! 😄

@christinerose
Copy link
Collaborator Author

Shall we merge this one for now until the indepth rewrite @cuihtlauac & @sabine

@sabine
Copy link
Collaborator

sabine commented May 15, 2023

@christinerose Indeed, it is merged.

@christinerose
Copy link
Collaborator Author

Oh Great! Thank you!

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