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

[craftedv2beta] Module documentation: crafted-updates #340

Merged
merged 3 commits into from
Sep 5, 2023
Merged

[craftedv2beta] Module documentation: crafted-updates #340

merged 3 commits into from
Sep 5, 2023

Conversation

sthesing
Copy link
Contributor

@sthesing sthesing commented Sep 1, 2023

Next in line from #128.

@sthesing sthesing mentioned this pull request Aug 30, 2023
17 tasks
Copy link
Contributor

@jvdydev jvdydev left a comment

Choose a reason for hiding this comment

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

Just a few things to discuss (nothing serious), otherwise looks good.


;; UPDATE: [2023-02-09 Thu] `crafted-emacs-home' is now set on load,
;; this can be updated to use that value for checking on updates from
;; This uses `crafted-emacs-home', which is set on load by if it hasn't been
Copy link
Contributor

@jvdydev jvdydev Sep 2, 2023

Choose a reason for hiding this comment

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

I might be reading this wrong, but is there a "by" too much?

This uses `crafted-emacs-home', which is set on load if it hasn't been 
set by the user or `crafted-init-config'.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh yes, that's right. Good eye, thank you!


You can use the functionality provided by this module in three ways:

1. On startup
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure on this mini "table of contents" when the content is directly following.

Especially in info-buffer, it looks a bit funny given 4-star headings are turned into numbered entries:

1. On startup
2. Regularly
3. Manually

1. On Startup
...

I'd personally remove it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. I agree.
Would you just remove it or turn it into a regular introductory sentence? "You can use the functionality provided by this module in three ways: on startup, regulary and manually."

Copy link
Contributor

Choose a reason for hiding this comment

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

I think putting it into the introductory sentence makes sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think putting it into the introductory sentence makes sense.

Think so, too. Amended it. Thanks for the feedback!

@jvdydev
Copy link
Contributor

jvdydev commented Sep 3, 2023

Regenerating info buffer, otherwise consider this approved from my end

@jeffbowman jeffbowman merged commit d610c5c into SystemCrafters:craftedv2beta Sep 5, 2023
@jeffbowman
Copy link
Contributor

Wow, somehow I missed this, sorry for the delay.

@sthesing sthesing deleted the v2b-doc-updates branch September 5, 2023 19:22
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.

None yet

3 participants