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

WIP: What are manifolds? #219

Open
wants to merge 24 commits into
base: master
Choose a base branch
from
Open

WIP: What are manifolds? #219

wants to merge 24 commits into from

Conversation

mateuszbaran
Copy link
Member

@mateuszbaran mateuszbaran commented Dec 3, 2024

A new general descriptions of what manifolds are.

@mateuszbaran mateuszbaran added documentation Improvements or additions to documentation preview docs Add this label if you want to see a PR-preview of the documentation labels Dec 3, 2024
Copy link

codecov bot commented Dec 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.97%. Comparing base (76d6a5f) to head (87c50f2).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #219   +/-   ##
=======================================
  Coverage   99.97%   99.97%           
=======================================
  Files          31       31           
  Lines        3535     3535           
=======================================
  Hits         3534     3534           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mateuszbaran mateuszbaran marked this pull request as ready for review December 5, 2024 10:54
@mateuszbaran mateuszbaran added the Ready-for-Review A label for pull requests that are feature-ready label Dec 5, 2024
@kellertuer
Copy link
Member

I carefully read this. It I a very good idea to introduce this.

  1. I would like to rephrase the beginning a bit, since currently it starts what we can not do. However, for now all we need and do implement is the definition used in the next section. So there is no need for the negativity.
  2. one could mention a bit, that some links point even to Manifolds.jl since that is not yet part of the interface – all links with icons upfront like at_point
  3. Also in topological part we again have a bit of a negative phrasing, but my larger problem is that the points 1-4 are nice to know but might yield the impression we would cover those already. We do not.
  4. The same as 3) for the Finsler manifolds. Currently these are not supported neither here in ManifoldsBase nor in Manifolds.jl – so that might be misleading in a tutorial?
  5. Finally, since the tutorial does not involve any code (or is that planned) it could also directly be written in markdown within the docs as a normal docs page – would that be reasonable?

I can try the next few days to write an introduction, that is positive, maybe not covering everything, but covering everything that is needed to get started and generalise or specialise it later when necessary. For a starl the topological charts are enough and there is no need to know that other definitions need variants of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation preview docs Add this label if you want to see a PR-preview of the documentation Ready-for-Review A label for pull requests that are feature-ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants