Skip to content

Update namespace table of contents#787

Merged
Planeshifter merged 1 commit into
developfrom
update-namespace-tocs
Jan 19, 2023
Merged

Update namespace table of contents#787
Planeshifter merged 1 commit into
developfrom
update-namespace-tocs

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

This PR

  • updates namespace table of contents

@github-actions github-actions Bot added automated-pr Automated pull request (e.g., from a bot). Documentation Improvements, additions, or changes to documentation. labels Dec 28, 2022

<div class="namespace-toc">

- <span class="signature">[`ndarrayCastingModes()`][@stdlib/ndarray/casting-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray casting modes.</span>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@Planeshifter I am not certain why these lines are being deleted. Based on the Git history for README.md and lib/index.js, I don't see an immediate reason why the README contents should change. Perhaps you know?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@Planeshifter I'm guessing that, until we determine what's going on here, we won't be able to merge namespace ToC PRs, as we'll keep seeing this undesired change.

@Planeshifter Planeshifter Jan 19, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@kgryte I think the issue is dispatch-by missing a README.md file; my hunch is that we have something fail in the process due to that.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also noticed that in a line above, we have a spelling mistake: contaians.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Fixed!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

After adding a skeleton README.md for dispatchBy, the workflow didn't erase any of the ndarray table of contents anymore! We could try to dig into this and guard against this case, but should be easy to avoid going forward, too.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@Planeshifter we should add a todo to the todo tracker. We cannot guarantee that when a package is a WIP that we'll have all files, including a README, nor should we have to. E.g., what if we're actively working on a package and a namespace ToC gets opened? We shouldn't be forced to add a README first because of undocumented institutional knowledge. It is fine for us because we can store all these things in our head, but not for others who may not have that knowledge. In general, our workflows should be robust against failure modes, and I don't think that this is an exception.

@github-actions
github-actions Bot force-pushed the update-namespace-tocs branch from c3d5cb5 to 24f9dec Compare January 1, 2023 22:31
@stdlib-bot
stdlib-bot force-pushed the update-namespace-tocs branch 2 times, most recently from 25adfe7 to 4976041 Compare January 19, 2023 21:29
@stdlib-bot
stdlib-bot force-pushed the update-namespace-tocs branch from 4976041 to d25b0ee Compare January 19, 2023 22:41
@Planeshifter

Copy link
Copy Markdown
Member

Checks have passed and the changes look fine now, merging in...

@Planeshifter
Planeshifter merged commit 1c5ac60 into develop Jan 19, 2023
@kgryte
kgryte deleted the update-namespace-tocs branch January 20, 2023 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated-pr Automated pull request (e.g., from a bot). Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants